AVEVA CAF API Documenation
Properties  Events

ITool Interface Members

The following tables list the members exposed by ITool.

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