Class InteractionConfiguration

Defines the set of interactive operations you can enable or disable for a VertexTool or FreehandTool.

Inheritance

System.Object

InteractionConfiguration

Implements

System.ComponentModel.INotifyPropertyChanged

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Esri.ArcGISRuntime.UI.Editing

Assembly: Esri.ArcGISRuntime.dll

Syntax

public sealed class InteractionConfiguration : INotifyPropertyChanged

Remarks

An InteractionConfiguration allows you to customize the interactive geometry editing experience to suit your specific users. For example:

Disable vertex, mid-vertex, and part selection (AllowVertexCreation, AllowMidVertexSelection, AllowPartCreation) to define a tool to only move the complete geometry.
Disable moving the selected element (AllowMovingSelectedElement) but allow all selections, and provide a tool for a user to enter new coordinates instead of moving interactively.

You can tap multiple times on any GeometryEditorElement to select the different types of GeometryEditorElement representing vertices, parts, and the entire geometry. For example if all elements are allowed to be selected:

tap twice on a vertex of a Multipoint to select first the vertex and then the entire multipoint geometry
tap three times on a vertex of a Polyline or Polygon to select first the vertex, then the part, and then the entire geometry
tap twice on an edge of a Polyline or Polygon to select first the part and then the entire geometry
tap twice on a fill of a Polygon to select first the part and then the entire geometry

You can change the interaction properties of a tool at any point, including when a geometry editor is started (IsStarted = true) and the tool is in use by the editor. If you change a property that disallows an in-progress interaction, then the interaction is cancelled and does not affect the state of the GeometryEditor.

Convenience methods are available to quickly set all properties relative to a category of interaction - for example use SetAllowSelection(Boolean) to change all selection interactions, and SetAllowTransformation(Boolean) to change all properties that control geometry transformation.

Constructors

Name	Description
InteractionConfiguration()	Initializes a new instance of the InteractionConfiguration class.

Properties

Name	Description
AllowDeletingSelectedElement	Gets or sets a value indicating whether the selected GeometryEditorElement can be interactively deleted. Default is `true`.
AllowGeometrySelection	Gets or sets a value indicating whether the entire geometry can be interactively selected. Default is `true`.
AllowMidVertexSelection	Gets or sets a value indicating whether to display mid-vertices and allow them to be selected interactively. Default is `true`.
AllowMovingSelectedElement	Gets or sets a value indicating whether the selected GeometryEditorElement can be interactively moved. Default is `true`.
AllowPartCreation	Gets or sets a value indicating whether you can interactively create a new part in a polyline or polygon. Default is `true`.
AllowPartSelection	Gets or sets a value indicating whether to allow a part of a Multipart geometry (Polyline or Polygon) to be selected interactively, `false` otherwise. Default is `true`.
AllowRotatingSelectedElement	Gets or sets a value indicating whether to allow you to interactively rotate the selected GeometryEditorElement. Default is `true`.
AllowScalingSelectedElement	Gets or sets a value indicating whether to allow you to interactively scale the selected GeometryEditorElement. Default is `true`.
AllowVertexCreation	Gets or sets a value indicating whether to allow a vertex to be created interactively. Default is `true`.
AllowVertexSelection	Gets or sets a value indicating whether to allow vertices to be selected interactively. Default is `true`.
RequireSelectionBeforeMove	Gets or sets a value indicating whether to require a GeometryEditorElement to first be selected before it can be moved by interactively dragging. Default is `false`.
ScaleMode	Gets or sets the determines how a geometry can be interactively scaled (resized) to fill its allocated space while using the GeometryEditor.

Methods

Name	Description
SetAllowCreation(Boolean)	Enable or disable creation.
SetAllowDeletion(Boolean)	Enable or disable deletion.
SetAllowSelection(Boolean)	Enable or disable selection.
SetAllowTransformation(Boolean)	Enable or disable interactions that transform the Geometry, for example AllowMovingSelectedElement.

Events

Name	Description
PropertyChanged	Occurs when a non-dependency property value changes.

Applies to

Target	Versions
.NET Standard 2.0	200.3 - 200.6
.NET	200.3 - 200.6
.NET Windows	200.3 - 200.6
.NET Android	200.3 - 200.6
.NET iOS	200.3 - 200.6
.NET Framework	200.3 - 200.6
UWP	200.3 - 200.6