Class MenuHandler
handles all Menu related aspects (context menu for building/refreshing, "DBAddin"/"Load Config" tree menu for retrieving stored configuration files, etc.)
Inheritance
System.Object
ExcelDna.Integration.ExcelComAddIn
ExcelDna.Integration.CustomUI.ExcelRibbon
MenuHandler
Inherited Members
ExcelDna.Integration.CustomUI.ExcelRibbon.NamespaceCustomUI2010
ExcelDna.Integration.CustomUI.ExcelRibbon.NamespaceCustomUI2007
ExcelDna.Integration.CustomUI.ExcelRibbon.LoadImage(System.String)
ExcelDna.Integration.CustomUI.ExcelRibbon.RunTagMacro(ExcelDna.Integration.CustomUI.IRibbonControl)
ExcelDna.Integration.ExcelComAddIn.OnConnection(System.Object, ExcelDna.Integration.Extensibility.ext_ConnectMode, System.Object, System.Array)
ExcelDna.Integration.ExcelComAddIn.OnDisconnection(ExcelDna.Integration.Extensibility.ext_DisconnectMode, System.Array)
ExcelDna.Integration.ExcelComAddIn.OnAddInsUpdate(System.Array)
ExcelDna.Integration.ExcelComAddIn.OnStartupComplete(System.Array)
ExcelDna.Integration.ExcelComAddIn.ProgId
Assembly: DBaddin.dll
Syntax
[ComVisible(true)]
public class MenuHandler : ExcelRibbon
Methods
|
Improve this Doc
View Source
clickAssignDBSheet(IRibbonControl)
clicked Assign DBSheet: create DB Mapper with CUD Flags
Declaration
public void clickAssignDBSheet(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
check/purge name tool button, purge names used for dbfunctions from workbook
Declaration
public void clickcheckpurgetoolbutton(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
context menu entries in Insert/Edit DBFunc/DBModif and Assign DBSheet: create DB function or DB Modification definition
Declaration
public void clickCreateButton(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
clickCreateDBSheet(IRibbonControl)
ribbon menu button for DBSheet creation start
Declaration
public void clickCreateDBSheet(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
context menu entry gotoDBFunc: jumps from DB function to data area and back
Declaration
public void clickjumpButton(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
clickrefreshData(IRibbonControl)
context menu entry refreshData: refresh Data in db function (if area or cell selected) or all db functions
Declaration
public void clickrefreshData(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
clickRepairLegacyFunctions(IRibbonControl)
Declaration
public void clickRepairLegacyFunctions(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
clickShowLog(IRibbonControl)
Declaration
public void clickShowLog(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
DBModifClick(IRibbonControl)
DBModif button activated, do DB Mapper/DB Action/DB Sequence or define existing (CtrlKey pressed)...
Declaration
public void DBModifClick(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
GetAdhocSQLItemCount(IRibbonControl)
Declaration
public int GetAdhocSQLItemCount(IRibbonControl control)
Parameters
Returns
|
Improve this Doc
View Source
GetAdhocSQLItemLabel(IRibbonControl, Int32)
Declaration
public string GetAdhocSQLItemLabel(IRibbonControl control, int index)
Parameters
Name |
Description |
control |
|
index |
|
Returns
|
Improve this Doc
View Source
GetAdhocSQLText(IRibbonControl)
Declaration
public object GetAdhocSQLText(IRibbonControl control)
Parameters
Returns
|
Improve this Doc
View Source
getConfig(IRibbonControl)
load config if config tree menu end-button has been activated (path to config xcl file is in control.Tag)
Declaration
public void getConfig(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
getCPropsImage(IRibbonControl)
display warning button icon on Cprops change if DBFskip is set...
Declaration
public string getCPropsImage(IRibbonControl control)
Parameters
Returns
|
Improve this Doc
View Source
GetCustomUI(String)
creates the Ribbon (only at startup). any changes to the ribbon can only be done via dynamic menus
Declaration
public override string GetCustomUI(string RibbonID)
Parameters
Name |
Description |
RibbonID |
|
Returns
Overrides
ExcelDna.Integration.CustomUI.ExcelRibbon.GetCustomUI(System.String)
|
Improve this Doc
View Source
getDBConfigMenu(IRibbonControl)
get DB Config Menu from File
Declaration
public string getDBConfigMenu(IRibbonControl control)
Parameters
Returns
|
Improve this Doc
View Source
getDBModifMenuContent(IRibbonControl)
create the buttons in the DBModif dropdown menu
Declaration
public string getDBModifMenuContent(IRibbonControl control)
Parameters
Returns
Description |
the menu content xml
|
|
Improve this Doc
View Source
getDBModifMenuVisible(IRibbonControl)
to show the DBModif sheet button only if it was collected...
Declaration
public bool getDBModifMenuVisible(IRibbonControl control)
Parameters
Returns
Description |
true if to be displayed
|
|
Improve this Doc
View Source
getDBModifScreentip(IRibbonControl)
show a screentip for the dynamic DBMapper/DBAction/DBSequence Menus (also showing the ID behind)
Declaration
public string getDBModifScreentip(IRibbonControl control)
Parameters
Returns
Description |
the screentip
|
|
Improve this Doc
View Source
getDBModifTypeLabel(IRibbonControl)
set the name of the DBModifType dropdown to the sheet name (for the WB dropdown this is the WB name)
Declaration
public string getDBModifTypeLabel(IRibbonControl control)
Parameters
Returns
|
Improve this Doc
View Source
GetEnvEnabled(IRibbonControl)
whether to enable environment selection drop down
Declaration
public int GetEnvEnabled(IRibbonControl control)
Parameters
Returns
Description |
true if enabled
|
|
Improve this Doc
View Source
GetEnvItemCount(IRibbonControl)
for environment dropdown to get the total number of the entries
Declaration
public int GetEnvItemCount(IRibbonControl control)
Parameters
Returns
|
Improve this Doc
View Source
GetEnvItemID(IRibbonControl, Int32)
for environment dropdown to get the ID of the entries
Declaration
public string GetEnvItemID(IRibbonControl control, int index)
Parameters
Name |
Description |
control |
|
index |
|
Returns
|
Improve this Doc
View Source
GetEnvItemLabel(IRibbonControl, Int32)
for environment dropdown to get the label of the entries
Declaration
public string GetEnvItemLabel(IRibbonControl control, int index)
Parameters
Name |
Description |
control |
|
index |
|
Returns
|
Improve this Doc
View Source
tool-tip for the environment select drop down
Declaration
public string GetEnvSelectedTooltip(IRibbonControl control)
Parameters
Returns
|
Improve this Doc
View Source
getLogsImage(IRibbonControl)
display warning icon on log button if warning has been logged...
Declaration
public string getLogsImage(IRibbonControl control)
Parameters
Returns
|
Improve this Doc
View Source
GetSelectedEnvironment(IRibbonControl)
after selection of environment (using selectEnvironment) used to return the selected environment
Declaration
public int GetSelectedEnvironment(IRibbonControl control)
Parameters
Returns
|
Improve this Doc
View Source
getSuperTipInfo(ref IRibbonControl)
used for additional information
Declaration
public object getSuperTipInfo(ref IRibbonControl control)
Parameters
Returns
|
Improve this Doc
View Source
getToggleCPropsScreentip(IRibbonControl)
display state of design-mode in screentip of dialogBox launcher
Declaration
public string getToggleCPropsScreentip(IRibbonControl control)
Parameters
Returns
Description |
screentip and the state of design-mode
|
|
Improve this Doc
View Source
getToggleDesignImage(IRibbonControl)
display state of design mode in icon of button
Declaration
public string getToggleDesignImage(IRibbonControl control)
Parameters
Returns
Description |
screentip and the state of design mode
|
|
Improve this Doc
View Source
getToggleDesignScreentip(IRibbonControl)
display state of design mode in screentip of button
Declaration
public string getToggleDesignScreentip(IRibbonControl control)
Parameters
Returns
Description |
screentip and the state of design mode
|
|
Improve this Doc
View Source
OnBeginShutdown(ref Array)
used to avoid crashes when closing excel (especially with multiple users of IntelliSenseServer)
Declaration
public override void OnBeginShutdown(ref Array custom)
Parameters
Overrides
ExcelDna.Integration.ExcelComAddIn.OnBeginShutdown(System.Array)
|
Improve this Doc
View Source
refreshDBConfigTree(IRibbonControl)
on demand, refresh the DB Config tree
Declaration
public void refreshDBConfigTree(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
ribbonLoaded(IRibbonUI)
callback after Excel loaded the Ribbon, used to initialize data for the Ribbon
Declaration
public void ribbonLoaded(IRibbonUI theRibbon)
Parameters
Name |
Description |
theRibbon |
|
|
Improve this Doc
View Source
selectEnvironment(IRibbonControl, String, Int32)
Choose environment (configured in registry with ConstConnString(N), ConfigStoreFolder(N))
Declaration
public void selectEnvironment(IRibbonControl control, string id, int index)
Parameters
Name |
Description |
control |
|
id |
|
index |
|
|
Improve this Doc
View Source
showAbout(IRibbonControl)
dialogBoxLauncher of DBAddin settings group: activate about box
Declaration
public void showAbout(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
showAddinConfig(IRibbonControl)
show xll standard config (AppSetting), central config (referenced by App Settings file attr) or user config (referenced by CustomSettings configSource attr)
Declaration
public void showAddinConfig(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
showCProps(IRibbonControl)
click on change props: show built-in properties dialog
Declaration
public void showCProps(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
showDBAdHocSQL(IRibbonControl, String)
show Ad-hoc SQL Query editor
Declaration
public void showDBAdHocSQL(IRibbonControl control, string selectedSQLText)
Parameters
Name |
Description |
control |
|
selectedSQLText |
|
|
Improve this Doc
View Source
showDBAdHocSQLDBOX(IRibbonControl)
dialogBoxLauncher of DBAddin settings group: activate adhoc SQL query dialog
Declaration
public void showDBAdHocSQLDBOX(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
showDBModifEdit(IRibbonControl)
show DBModif definitions edit box
Declaration
public void showDBModifEdit(IRibbonControl control)
Parameters
|
Improve this Doc
View Source
showToggleDesignMode(IRibbonControl)
toggle design mode button
Declaration
public void showToggleDesignMode(IRibbonControl control)
Parameters