AVEVA CAF API Documenation
Fields  Properties  Methods  Events


Tool Class Members

The following tables list the members exposed by Tool.

Protected Fields
 NameDescription
Protected Field True if defined in xml file  
Protected Field Used to logically attach another object or value to a tool  
Protected Field Tool type flag  
Top
Public Properties
 NameDescription
Public Property Gets or sets the tools arguments.  
Public Property Gets or sets the name of the group the instance tool should be contained within when placed on a RibbonGroup.  
Public Property Gets or sets the tool caption  
Public Property Gets or sets the tools category  
Public Property Flag to indicate if a large image should be displayed for an instance of a tool on the ribbon  
Public Property Gets or sets the display style for a tool.  
Public Property Gets or sets the enabled state of the tool.  
Public Property Returns or sets the help context identifier used for F1 contextual help.  
Public Property Gets or sets the image (16x16) displayed on the tool  
Public Property Flag to indicate if the tool should only display an image and no caption.  
Public Property 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.  
Public Property Gets or sets whether tool is xml defined  
Public Property The Key of the tool in the RootToolsCollection  
Public Property Returns or sets a string with a maximum of 3 characters that represents the mnemonic that is displayed when using keytips.  
Public Property Gets or sets the large image (32x32) displayed on the tool  
Public Property Sets the List of items used by the tool.  
Public Property Gets or sets the shortcut associated with a tool.  
Public Property Gets or sets the image (16x16) displayed on the tool  
Public Property Gets or sets the tag property which can be used to logically attach another object or value to a tool.  
Public Property Gets or sets the tools tooltip  
Public Property Gets / sets the formatted text to be displayed in the tooltip.  
Public Property Gets or sets the text displayed for the tooltip title  
Public Property Gets or sets the value of the tool.  
Top
Public Methods
 NameDescription
Public MethodReturns a string that represents the current object.  
Top
Protected Methods
 NameDescription
Protected Method Fired when tool visibility changes  
Top
Public Events
 NameDescription
Public Event Fires if tool visibility changes  
Top
See Also