MenuTool Class Members
The following tables list the members exposed by MenuTool.
Protected Fields
Name | Description | |
---|---|---|
_isXmlDefined | True if defined in xml file (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
_tag | Used to logically attach another object or value to a tool (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
IsRootTool | Tool type flag (Inherited from Aveva.ApplicationFramework.Presentation.Tool) |
Public Properties
Name | Description | |
---|---|---|
AllowTearaway | Gets or sets whether the menu can be torn off | |
Arguments | Gets or sets the tools arguments. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
AutoUpdate | Gets or sets whether the Image, Tooltip and Command are automatically updated. | |
ButtonGroup | Gets or sets the name of the group the instance tool should be contained within when placed on a RibbonGroup. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
Caption | Gets or sets the tool caption (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
Category | Gets or sets the tools category (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
Checked | Gets or sets whether the tool is in the checked state. | |
Command | Gets the command object which was associated with the tool when it was created. | |
CommandChecked | Sets the tool's checked state. | |
Displayed | Gets whether the menu is currently displayed. | |
DisplayLargeImage | Flag to indicate if a large image should be displayed for an instance of a tool on the ribbon (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
DisplayStyle | Gets or sets the display style for a tool. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
DropDownArrowStyle | Returns or sets the style of the dropdown arrow for the popup menu. | |
Enabled | Gets or sets the enabled state of the tool. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
HelpContextID | Returns or sets the help context identifier used for F1 contextual help. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
Image | Gets or sets the image (16x16) displayed on the tool (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
ImageOnly | Flag to indicate if the tool should only display an image and no caption. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
IsContextMenu | Gets or sets whether the menu is a context menu | |
IsFirstInGroup | Gets or sets a flag which indicated whether an instance tool is the first in a tool group. A separator will be displayed before a tool if this property is set to true. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
IsXmlDefined | Gets or sets whether tool is xml defined (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
Key | The Key of the tool in the RootToolsCollection (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
KeyTip | Returns or sets a string with a maximum of 3 characters that represents the mnemonic that is displayed when using keytips. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
LargeImage | Gets or sets the large image (32x32) displayed on the tool (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
List | Sets the List of items used by the tool. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
OptionSetKey | Gets or sets the OptionSet key for the tool. Setting the key assigns the tool to the CommandBarManagers OptionSet which has this key. | |
PopupStyle | Gets or sets the popup style of the menu (Menu or CommandBar) | |
SelectedToolKey | Gets or sets the Selected Tools Key | |
Serializable | Gets or sets a value indicating whether to set the state on restart. | |
Shortcut | Gets or sets the shortcut associated with a tool. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
SmallImage | Gets or sets the image (16x16) displayed on the tool (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
Tag | Gets or sets the tag property which can be used to logically attach another object or value to a tool. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
Tools | Gets the ToolsCollection containing the tools to display in the popup menu. | |
Tooltip | Gets or sets the tools tooltip (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
TooltipFormattedText | Gets / sets the formatted text to be displayed in the tooltip. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
TooltipTitle | Gets or sets the text displayed for the tooltip title (Inherited from Aveva.ApplicationFramework.Presentation.Tool) | |
UseLargeImages | Use large images | |
Value | Gets or sets the value of the tool. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) |
Public Methods
Name | Description | |
---|---|---|
ShowPopup | Overloaded. Displays the MenuTool as a context popup at the current mouse position. | |
ToString | Returns a string that represents the current object. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) |
Protected Methods
Name | Description | |
---|---|---|
OnVisibilityChanged | Fired when tool visibility changes (Inherited from Aveva.ApplicationFramework.Presentation.Tool) |
Public Events
Name | Description | |
---|---|---|
AfterCloseup | Occurs after the menu is displayed | |
AfterPopup | Occurs after the menu is displayed | |
BeforePopup | Occurs before the menu is displayed | |
ToolClick | Occurs when the tool is clicked | |
VisibilityChanged | Fires if tool visibility changes (Inherited from Aveva.ApplicationFramework.Presentation.Tool) |
See Also