MenuHandler Class
handles all Menu related aspects (context menu for building/refreshing, "DBAddin"/"Load Config" tree menu for retrieving stored configuration files, etc.)
Inheritance Hierarchy
- ExcelDna.Integration.CustomUI.ExcelRibbon
- DBaddin.MenuHandler
Namespace: DBaddinAssembly: DBaddin in (DBaddin.dll)
Syntax
public class MenuHandler : ExcelRibbon
The MenuHandler type exposes the following members.
Constructors
| Class | Summary | |
|---|---|---|
 | MenuHandler() |
Methods
| Name | Summary | |
|---|---|---|
 | clickAssignDBSheet(IRibbonControl) | clicked Assign DBSheet: create DB Mapper with CUD Flags |
| clickcheckpurgetoolbutton(IRibbonControl) | check/purge name tool button, purge names used for db-functions from workbook |
| clickCreateButton(IRibbonControl) | context menu entries in Insert/Edit DBFunc/DBModif and Assign DBSheet: create DB function or DB Modification definition |
| clickCreateChart(IRibbonControl) | context menu entry: create Chart for underlying Pivot table |
| clickCreateDBSheet(IRibbonControl) | ribbon menu button for DBSheet creation start |
| clickjumpButton(IRibbonControl) | context menu entry gotoDBFunc: jumps from DB function to data area and back |
| clickrefreshData(IRibbonControl) | context menu entry refreshData: refresh Data in db function (if area or cell selected) or all db functions |
| clickShowLog(IRibbonControl) | show the trace log |
 | convertFromMso(String) | converts a Mso Menu ID to a Drawing Image |
| ctMenuStrip_Click(Object, EventArgs) | called after selecting DBMapper/DBAction/DBSequence from the dialogBoxLauncher |
| ctMenuStrip2_Click(Object, EventArgs) | called after selecting a power-query for insert DBSetPowerQuery |
| DBModifClick(IRibbonControl) | DBModif button activated, do DB Mapper/DB Action/DB Sequence or define existing (CtrlKey pressed)... |
| GetAdhocSQLItemCount(IRibbonControl) | get the total item count for the AdHocSQLStrings collection |
| GetAdhocSQLItemLabel(IRibbonControl, Int32) | get the labels for the AdHocSQL combo-box |
| GetAdhocSQLText(IRibbonControl) | get the text for the currently selected AdHocSQL string from the AdHocSQLStrings collection |
| getConfig(IRibbonControl) | load config if config tree menu end-button has been activated (path to config xcl file is in control.Tag), also provides access to documentation if provided in setting ConfigDocQuery |
| getCPropsImage(IRibbonControl) | display warning button icon on custom properties change if DBFskip is set... |
| GetCustomUI(String) | creates the Ribbon (only at startup). any changes to the ribbon can only be done via dynamic menus |
| getDBConfigMenu(IRibbonControl) | get DB Config Menu from File |
| getDBModifImage(IRibbonControl) | display error icon for DBModif errors |
| getDBModifMenuContent(IRibbonControl) | create the buttons in the DBModif dropdown menu |
| getDBModifMenuVisible(IRibbonControl) | to show the DBModif sheet button only if it was collected... |
| getDBModifScreentip(IRibbonControl) | show a screen-tip for the dynamic DBMapper/DBAction/DBSequence Menus (also showing the ID behind) |
| getDBModifTypeLabel(IRibbonControl) | set the name of the DBModifType dropdown to the DBModifier Typename |
| GetEnvEnabled(IRibbonControl) | whether to enable environment selection drop down |
| GetEnvItemCount(IRibbonControl) | for environment dropdown to get the total number of the entries |
| GetEnvItemID(IRibbonControl, Int32) | for environment dropdown to get the ID of the entries |
| GetEnvItemLabel(IRibbonControl, Int32) | for environment dropdown to get the label of the entries |
| GetEnvSelectedTooltip(IRibbonControl) | tool-tip for the environment select drop down |
| getLogsImage(IRibbonControl) | display warning icon on log button if warning has been logged... |
| GetSelectedEnvironment(IRibbonControl) | after selection of environment (using selectEnvironment) used to return the selected environment |
| getStatusAndExtent(ref Boolean, ref Boolean) | common fetching function for getting the Status and the extent of the preventRefresh flag |
| getSuperTipInfo(ref IRibbonControl) | used for additional information |
| getToggleCPropsScreentip(IRibbonControl) | display DBAddin custom properties/values in screen-tip of dialogBox launcher |
| getToggleDesignImage(IRibbonControl) | display state of design mode in icon of button |
| getToggleDesignScreentip(IRibbonControl) | display state of design mode in screen-tip of button |
| getTogglePreventRefreshImage(IRibbonControl) | display state of PreventRefresh in icon of button |
| getTogglePreventRefreshScreentip(IRibbonControl) | display state of PreventRefresh in screen-tip of button |
| initAdhocSQLconfig() | initialize the AdhocSQL ribbon combo-box entries |
| OnBeginShutdown(ref Array) | used to avoid crashes when closing excel (especially with multiple users of IntelliSenseServer) |
| OnDisconnection(ext_DisconnectMode, ref Array) | used to clean up com objects to avoid excel crashes on shutdown |
| refreshDBConfigTree(IRibbonControl) | on demand, refresh the DB Config tree |
| ribbonLoaded(IRibbonUI) | callback after Excel loaded the Ribbon, used to initialize data for the Ribbon |
| selectEnvironment(IRibbonControl, String, Int32) | Choose environment (configured in settings with ConstConnString(N), ConfigStoreFolder(N)) |
| showAbout(IRibbonControl) | dialogBoxLauncher of DBAddin settings group: activate about box |
| showAddinConfig(IRibbonControl) | show xll standard config (AppSetting), central config (referenced by App Settings file attr) or user config (referenced by CustomSettings configSource attr) |
| showCProps(IRibbonControl) | click on change props: show built-in properties dialog |
| showDBAdHocSQL(IRibbonControl, String) | show Ad-hoc SQL Query editor |
| showDBAdHocSQLDBOX(IRibbonControl) | dialogBoxLauncher of DBAddin settings group: activate ad-hoc SQL query dialog |
| showDBModifEdit(IRibbonControl) | show DBModif definitions edit box |
| showToggleDesignMode(IRibbonControl) | toggle design mode button |
| showTogglePreventRefresh(IRibbonControl) | toggle PreventRefresh button |
Properties
| Name | Summary | |
|---|---|---|
 | ctMenuStrip | menu strip for DB Modifier Definitions dialogBoxLauncher |
| ctMenuStrip2 | menu strip for displaying available power queries in current workbook |
Fields
| Name | Description | |
|---|---|---|
 | AdHocSQLStrings | the collection of all the configured/stored AdHocSQL Strings |
| selectedAdHocSQLIndex | the index of the currently selected AdHocSQL String |