ArcGIS Pro 3.3 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / LayoutTool Class
Properties Methods Events


In This Topic
    LayoutTool Class Members
    In This Topic

    The following tables list the members exposed by LayoutTool.

    Public Properties
     NameDescription
    Public Property Gets the active element container.  
    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. (Inherited from ArcGIS.Desktop.Framework.Contracts.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 ArcGIS.Desktop.Framework.Contracts.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 or sets the DAML ID of the context menu for the tool.  
    Protected Property Gets or sets the DAML ID of the toolbar to display for the tool.  
    Protected Property Gets a read only ShortCut collection for the current tool. (Inherited from ArcGIS.Desktop.Framework.Contracts.Tool)
    Protected PropertyGets or sets the number of sides for a regular polygon. Use when SketchType = ArcGIS.Desktop.Mapping.SketchGeometryType.RegularPolygon or SketchType = ArcGIS.Desktop.Mapping.SketchGeometryType.RegularPolyline.  
    Protected Property Gets the symbol to use for the sketch.  
    Protected Property Gets or sets the type or shape of the geometry to be created by the sketch.  
    Protected Property Gets or sets whether to use snapping to precisely sketch on the active view. The default value is false.  
    Top
    Protected Methods
     NameDescription
    Protected Method Clears the current sketch in the active view.  
    Protected Method Finishes the current sketch in the active view.  
    Protected Method Gets the current geometry of the sketch without finishing it.  
    Protected MethodOccurs when the OnToolDoubleClick event is handled.  
    Protected MethodOccurs when the OnToolKeyDown event is handled.  
    Protected MethodOccurs when the OnToolKeyUp event is handled.  
    Protected MethodOccurs when the OnToolMouseDown event is handled.  
    Protected MethodOccurs when the OnToolMouseUp event is handled.  
    Protected Method Called to inform the Tool a Pane referencing it as the active tool is activating or deactivating.  
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Internal Method Occurs when a pointer is pressed on a Pane and the tool is active. (Inherited from ArcGIS.Desktop.Framework.Contracts.Tool)
    Protected Internal Method Occurs when a pointer is released over a Pane. (Inherited from ArcGIS.Desktop.Framework.Contracts.Tool)
    Protected Method Occurs when a sketch is canceled.  
    Protected Method Occurs when a sketch is finished.  
    Protected Method Occurs when a sketch is modified.  
    Protected Method Occurs when the tool is activated.  
    Protected Method Occurs when the tool is deactivated.  
    Protected Method Occurs when a mouse button is clicked on the view two or more times.  
    Protected Method Occurs when a key is pressed and the view has focus.  
    Protected Method Occurs when a key is released and the view has focus.  
    Protected Method Occurs when a mouse button is pressed on the view.  
    Protected Method Occurs when the mouse pointer moves over the view.  
    Protected Method Occurs when a mouse button is released on the view.  
    Protected Internal Method Occurs when a touch event occurs over a Pane. (Inherited from ArcGIS.Desktop.Framework.Contracts.Tool)
    Protected Internal Method Called periodically by the framework once the tool has been created. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Protected Method Sets the current geometry of the sketch without finishing it.  
    Protected MethodOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected Method Start a new sketch.  
    Protected MethodOverridden.  Occurs when a cursor is set on this tool. Forward the cursor to the inner tool.  
    Top
    Public Events
     NameDescription
    Public Event Occurs when a property value changes. (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also