ArcGIS Pro 3.4 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / MapTool Class


In This Topic
    MapTool Class Properties
    In This Topic

    For a list of all members of this type, see MapTool members.

    Public Properties
     NameDescription
    Public PropertyCaption Gets or sets the command label as it appears in the ribbon and customize dialog. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public PropertyCursor Gets or sets the mouse pointer for this tool. (Inherited from ArcGIS.Desktop.Framework.Contracts.Tool)
    Public PropertyDisabledTooltipGets or sets the supplementary text that appears with the Tooltip only when the command is disabled. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public PropertyEnabled Gets or sets a boolean to specify whether the control is enabled. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public PropertyID Gets the DAML identifier. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn)
    Public PropertyIsCheckedGets or sets whether the ArcGIS.Desktop.Framework.Contracts.Button is checked. (Inherited from ArcGIS.Desktop.Framework.Contracts.Button)
    Public PropertyLargeImage 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 PropertySmallImage 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 PropertyTooltip 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 PropertyTooltipHeading 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 PropertyActiveMapViewGets the active MapView.  
    Protected PropertyCompleteSketchOnMouseUp Gets or sets the mouse up behavior for Rectangle/Circle/Ellipse/Freehand sketches.  
    Protected PropertyContextMenuID Gets or sets the DAML ID of the context menu for the tool.  
    Protected PropertyContextToolbarID Gets or sets the DAML ID of the toolbar to display for the tool.  
    Protected PropertyControlID Gets or sets the DAML ID of the embeddable control to show in the dock pane when the tool is active.  
    Protected PropertyCurrentTemplate Gets the active editing template being used by the tool.  
    Protected PropertyCurrentTemplateRows Gets or sets the number of rows to be created with the current template. Use this when the MapTool is registered with the "esri_editing_construction_table" category indicating the tool is a table construction tool.  
    Protected PropertyEmbeddableControlGets the EmbeddableControl created for the tool. This is the control set by the ControlID property.  
    Protected PropertyFireSketchEvents Gets or sets whether the tool supports firing sketch events when the map sketch changes. Default value is false.  
    Protected PropertyGeomIsSimpleAsFeatureGets or sets whether the geometry constructed from a finished sketch should be simplified prior to being returned to OnSketchCompleteAsync. The default value is true.  
    Protected PropertyIsSketchTipControlTransparentGets and sets if the sketch tip embeddable control is transparent. The default value is false. The sketch tip embeddable control is the control set by the SketchTipID property.  
    Protected PropertyIsSketchTool Gets or sets whether the MapTool's default behavior of a left click should be to create a sketch.  
    Protected PropertyIsWYSIWYG Gets or sets whether the sketch shows a symbol.  
    Protected PropertyKeepControlOpenAfterDeactivation Optional property to allow tool's embeddable control to remain open after the tool is deactivated.  
    Protected PropertyOverlayControlCanResize Gets or sets whether the embeddable control on the map view can be resized.  
    Protected PropertyOverlayControlID Gets or sets the DAML ID of the embeddable control to show on the map view when the tool is active.  
    Protected PropertyOverlayControlPositionRatio Gets or sets the position of the embeddable control on the map view as a ratio.  
    Protected PropertyOverlayEmbeddableControlGets the EmbeddableControl created for the tool to be shown on the map view. This is control set by the OverlayControlID property.  
    Protected PropertySegmentContextMenuID Gets or sets the DAML ID of the context menu shown when modifying a segment.  
    Protected PropertyShortcuts Gets a read only ShortCut collection for the current tool. (Inherited from ArcGIS.Desktop.Framework.Contracts.Tool)
    Protected PropertyShowGroundToGridCorrections Gets or sets whether the ground to grid corrections heads-up display is shown when ground to grid is turned on in the UI. Default is false.  
    Protected PropertyShowUncommittedSketchDialog Gets or sets whether the uncommitted sketch dialog is shown. Default is false.  
    Protected PropertySketchMode Gets and sets the SketchMode for the MapTool.  
    Protected PropertySketchNumberOfSidesGets or sets the number of sides for a regular polygon. Use when SketchType = SketchGeometryType.RegularPolygon or SketchType = SketchGeometryType.RegularPolyline.  
    Protected PropertySketchOutputMode Gets or sets if the sketch geometry should be created using map or screen coordinates.  
    Protected PropertySketchOverlaySymbol Gets or sets the sketch symbology when the sketch is in selection mode.  
    Protected PropertySketchSymbol Gets or sets the symbol to use for the sketch. This is only supported when creating a sketch in map coordinates.  
    Protected PropertySketchTipGets and sets text for a sketch tip.The text follows the cursor when the tool is active.  
    Protected PropertySketchTipControlPositionGets and sets the position for the sketch tip embeddable control. The default value is SketchTipControlPosition.LowerRight. The sketch tip embeddable control is the control set by the SketchTipID property.  
    Protected PropertySketchTipEmbeddableControlGets the Embeddable Control for the sketch tip for this tool. This is the control set by the SketchTipID property.  
    Protected PropertySketchTipID Gets and sets the DAML ID of the embeddable control to show as a sketch tip.The control follows the cursor when the tool is active.  
    Protected PropertySketchType Gets or sets the type or shape of the geometry to be created by the sketch.  
    Protected PropertySnappingResultsGets the SnapResult for each vertex in the current sketch.  
    Protected PropertyUsesCurrentTemplate Gets or sets whether the sketch is for creating a feature and should use the CurrentTemplate.  
    Protected PropertyUseSelectionGets or sets if the sketch needs a selection in order to operate. This requirement allows the tool to have two different modes; the normal sketch mode and an additional selection mode.The user is able to toggle the tool between sketch and select modes by pressing and holding down the SHIFT key. When this occurs the sketch is suspended and the user can select additional features. Releasing the SHIFT key puts the tool back into sketch mode, restores the previous state of the sketch (and the sketch undo / redo stack) and allows you to resume sketching.

    The default value is false.  
    Protected PropertyUseSnapping Gets or sets whether to use snapping to precisely sketch on the active map view. The default value is false.  
    Top
    See Also

    Reference

    MapTool Class
    ArcGIS.Desktop.Mapping Namespace

     

     

    ©2024 Esri Inc., All Rights Reserved. Generated on Saturday, October 26, 2024

    Send feedback