ComboBoxTool Class Members
The following tables list the members exposed by ComboBoxTool.
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 | |
---|---|---|
![]() | Arguments | Gets or sets the tools arguments. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) |
![]() | AutoComplete | Gets or sets whether the edit portion is automatically updated to match an item in the list as new characters are typed. |
![]() | 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) |
![]() | Command | Gets the command object which was associated with the tool when it was created. |
![]() | 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) |
![]() | DisplayText | Gets or sets the text displayed in the tool. |
![]() | Editable | Gets or sets whether the text portion of the ComboBoxTool is editable. |
![]() | 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) |
![]() | 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) |
![]() | MaxLength | Gets or sets the maximum allowable length of the text that can be entered in the ComboBoxTool. |
![]() | PasswordChar | Gets or sets a value indicating how the characters typed by a user are displayed. |
![]() | RealSizeImagesInPreview | Flag to control image scaling in preview |
![]() | SelectedIndex | Gets or sets the zero-based index of the selected item in the ValueList. |
![]() | SelectedValue | Returns the object behind the selected ValueList item. |
![]() | 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) |
![]() | 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) |
![]() | Value | Gets or sets the value of the tool. (Inherited from Aveva.ApplicationFramework.Presentation.Tool) |
![]() | ValueList | Gets the ValueList object associated with the ComboBoxTool. |
![]() | Width | Gets or sets the width of the tool. |
Public Methods
Name | Description | |
---|---|---|
![]() | 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 popup part of the tool is closed. |
![]() | AfterPopup | Occurs after the popup part of the tool is displayed. |
![]() | BeforePopup | Occurs before the popup part of the tool is displayed. |
![]() | ToolClick | Occurs when Enter key is pressed while display field has focus. |
![]() | ToolValueChanged | Occurs when the value of the tool changes. |
![]() | VisibilityChanged | Fires if tool visibility changes (Inherited from Aveva.ApplicationFramework.Presentation.Tool) |
See Also