Common Application Framework

ListTool Members

ListTool overview

Public Instance Properties

Caption Gets or sets the tool caption
Category Gets or sets the tools category
Command Gets the command object which was associated with the tool when it was created.
DisplayCheckmark Returns or sets whether a checkmark should be displayed next to the selected ListToolItem.
Enabled Gets or sets the enabled state of the tool.
Image Gets or sets the image displayed on the 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.
Key The Key of the tool in the RootToolsCollection
SelectedItemIndex Returns the index of the currently selected ListToolItem.
Shortcut Gets or sets the shortcut associated with a tool.
Tag Gets or sets the tag property which can be used to logically attach another object or value to a tool.
Tooltip Gets or sets the tools tooltip
Value Gets or sets the value of the tool.
ValueList Gets the ValueList object associated with the ComboBoxTool.
Visible Gets or sets the visibility of the tool.

Public Instance Methods

Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
ToString (inherited from Object) Returns a String that represents the current Object.

Public Instance Events

BeforePopup Occurs before the menu containing the ListTool is displayed
ToolClick Occurs when the ButtonTool is clicked.

See Also

ListTool Class | Aveva.ApplicationFramework.Presentation Namespace