| Name | Description | |
|---|---|---|
 | Caption | Gets or sets the command label as it appears in the ribbon and customize dialog. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn) |
| Cursor | Gets or sets the mouse pointer for this tool. (Inherited from ArcGIS.Desktop.Framework.Contracts.Tool) |
| DisabledTooltip | Gets or sets the supplementary text that appears with the Tooltip only when the command is disabled. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn) |
| Enabled | Gets or sets a boolean to specify whether the control is enabled. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn) |
| ID | Gets the DAML identifier. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn) |
| IsChecked | Gets or sets whether the ArcGIS.Desktop.Framework.Contracts.Button is checked. (Inherited from ArcGIS.Desktop.Framework.Contracts.Button) |
| LargeImage | 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) |
| SmallImage | 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) |
| Tooltip | 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) |
| TooltipHeading | Gets or sets a one or two word label that appears above the tooltip. (Inherited from ArcGIS.Desktop.Framework.Contracts.PlugIn) |
MapTool Class Properties
In This Topic
For a list of all members of this type, see MapTool members.
Public Properties
Protected Properties
| Name | Description | |
|---|---|---|
 | ActiveMapView | Gets the active MapView. |
| CompleteSketchOnMouseUp | Gets or sets the mouse up behavior for Rectangle/Circle/Ellipse/Freehand sketches. |
| ContextMenuID | Gets or sets the DAML ID of the context menu for the tool. |
| ContextToolbarID | Gets or sets the DAML ID of the toolbar to display for the tool. |
| ControlID | Gets or sets the DAML ID of the embeddable control to show in the dock pane when the tool is active. |
| CurrentTemplate | Gets the active editing template being used by the tool. |
| CurrentTemplateRows | 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. |
| EmbeddableControl | Gets the EmbeddableControl created for the tool. This is the control set by the ControlID property. |
| FireSketchEvents | Gets or sets whether the tool supports firing sketch events when the map sketch changes. Default value is false. |
| GeomIsSimpleAsFeature | Gets or sets whether the geometry constructed from a finished sketch should be simplified prior to being returned to OnSketchCompleteAsync. The default value is true. |
| IsSketchTool | Gets or sets whether the MapTool's default behavior of a left click should be to create a sketch. |
| IsWYSIWYG | Gets or sets whether the sketch shows a symbol. |
| KeepControlOpenAfterDeactivation | Optional property to allow tool's embeddable control to remain open after the tool is deactivated. |
| OverlayControlCanResize | Gets or sets whether the embeddable control on the map view can be resized. |
| OverlayControlID | Gets or sets the DAML ID of the embeddable control to show on the map view when the tool is active. |
| OverlayControlPositionRatio | Gets or sets the position of the embeddable control on the map view as a ratio. |
| OverlayEmbeddableControl | Gets the EmbeddableControl created for the tool to be shown on the map view. This is control set by the OverlayControlID property. |
| SegmentContextMenuID | Gets or sets the DAML ID of the context menu shown when modifying a segment. |
| Shortcuts | Gets a read only ShortCut collection for the current tool. (Inherited from ArcGIS.Desktop.Framework.Contracts.Tool) |
| ShowUncommittedSketchDialog | Gets or sets whether the uncommitted sketch dialog is shown. Default is false. |
| SketchMode | Gets and sets the SketchMode for the MapTool. |
| SketchNumberOfSides | Gets or sets the number of sides for a regular polygon. Use when SketchType = SketchGeometryType.RegularPolygon or SketchType = SketchGeometryType.RegularPolyline. |
| SketchOutputMode | Gets or sets if the sketch geometry should be created using map or screen coordinates. |
| SketchOverlaySymbol | Gets or sets the sketch symbology when the sketch is in selection mode. |
| SketchSymbol | Gets or sets the symbol to use for the sketch. This is only supported when creating a sketch in map coordinates. |
| SketchTip | Gets and sets text for a sketch tip.The text follows the cursor when the tool is active. |
| SketchTipEmbeddableControl | Gets the Embeddable Control for the sketch tip for this tool. This is the control set by the SketchTipID property. |
| SketchTipID | 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. |
| SketchType | Gets or sets the type or shape of the geometry to be created by the sketch. |
| SnappingResults | Gets the SnapResult for each vertex in the current sketch. |
| UsesCurrentTemplate | Gets or sets whether the sketch is for creating a feature and should use the CurrentTemplate. |
| UseSelection | Gets or sets if the sketch can enter sketch selection mode by holding the SHIFT key. Sketch selection mode allows you to select additional features while sketching. The sketch state is saved in selection mode. Releasing the SHIFT key returns you to sketch mode and allows you to resume sketching. The default value is False. |
| UseSnapping | Gets or sets whether to use snapping to precisely sketch on the active map view. The default value is false. |
See Also