ArcGIS Pro 3.1 API Reference Guide
ArcGIS.Desktop.Framework.Contracts Namespace / Tool Class
Properties Methods Events


In This Topic
    Tool Class Members
    In This Topic

    The following tables list the members exposed by Tool.

    Public Properties
     NameDescription
    Public Property Gets or sets the command label as it appears in the ribbon and customize dialog. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets or sets the mouse pointer for this tool.  
    Public PropertyGets or sets the supplementary text that appears with the Tooltip only when the command is disabled. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets or sets a boolean to specify whether the control is enabled. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets the DAML identifier. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public PropertyGets or sets whether the Button is checked. (Inherited from ArcGIS.Desktop.Framework.Contracts.Button)
    Public Property Gets or sets the large representation of the command, this may be an image or a xaml element. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets or sets the small representation of the command, this may be an image or a xaml element. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets or sets a brief description of the command that appears in a small pop-up window when a user pauses the mouse pointer over an element, such as over a Button. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public Property Gets or sets a one or two word label that appears above the tooltip. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Top
    Protected Properties
     NameDescription
    Protected Property Gets a read only ShortCut collection for the current tool.  
    Top
    Protected Methods
     NameDescription
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal Method Called to inform the Tool it has been activated or deactivated.  
    Protected Internal Method Called on the active tool when a pane change occurrs to see if the tool wants to remain active.  
    Protected Internal Method Called when the Button is clicked. (Inherited from ArcGIS.Desktop.Framework.Contracts.Button)
    Protected Internal Method Occurs when a mouse button is clicked on a Pane two or more times.  
    Protected Internal Method Occurs when a key is pressed and the tool is active.  
    Protected Internal Method Occurs when a key is released and the tool is active.  
    Protected Internal Method Occurs when a mouse button is pressed on a Pane and the tool is active.  
    Protected Internal Method Occurs when the mouse pointer moves over a Pane and the tool is active.  
    Protected Internal Method Occurs when any mouse button is released over a Pane.  
    Protected Internal Method Called to inform the Tool a Pane referencing it as the active tool is activating or deactivating.  
    Protected Internal Method Occurs when a pointer is pressed on a Pane and the tool is active.  
    Protected Internal Method Occurs when a pointer is released over a Pane.  
    Protected Internal Method Occurs when a touch event occurs over a Pane.  
    Protected Internal Method Called periodically by the framework once the tool has been created. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Method Occurs when a cursor is set on this tool.  
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also