Class SnapSourceSettings

Configures a valid source of geometries that the GeometryEditor can snap interactive edits to.

Inheritance

System.Object

SnapSourceSettings

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 SnapSourceSettings : INotifyPropertyChanged

Remarks

Following a call to SyncSourceSettings() or SyncSourceSettings(SnapRules, SnapSourceEnablingBehavior), the SourceSettings collection is populated with SnapSourceSettings objects that are valid for snapping. Each represents a ISnapSource that is in the currently connected map and provides full resolution geometries suitable for snapping.

FeatureLayer, GraphicsOverlay, SubtypeFeatureLayer, and SubtypeSublayer objects are types of snap source. For SubtypeFeatureLayer snap sources, the ChildSourceSettings collection is populated with SubtypeSublayer snap sources.

Set IsEnabled to true for each item that you want allow your users to snap to. You may wish to delegate the choice of snapping sources to users by binding the collection of snapping sources to controls which allow them to change IsEnabled for each snapping source individually. When rule-based snapping is configured, interactive snapping behavior is affected by the SnapRules used in SyncSourceSettings(SnapRules, SnapSourceEnablingBehavior). See SnapRules and RuleBehavior for more information.

Snapping works for visible objects within a visible ISnapSource - for example if a feature layer or graphics overlay is not visible due to the current scale range, definition expression, or other reason, it will not participate in snapping at that time. Visibility does not affect whether a SnapSourceSettings object is present in the SourceSettings collection or not.

See ISnapSource for more information about which data sources are valid for snapping.

Properties

Name	Description
ChildSourceSettings	Gets a collection of SnapSourceSettings objects representing the child snap sources of Source, when the snap source is a SubtypeFeatureLayer.
IsEnabled	Gets or sets a value indicating whether to enable snapping to the geometries in the ISnapSource, `false` otherwise. Default is `false`.
RuleBehavior	Gets a value that describes how SnapRules affect the interactive snapping behavior of this SnapSourceSettings.
Source	Gets the underlying source of geometries to snap to, for example a FeatureLayer or GraphicsOverlay.

Events

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

Applies to

Target	Versions
.NET Standard 2.0	200.4 - 200.7
.NET	200.4 - 200.7
.NET Windows	200.4 - 200.7
.NET Android	200.4 - 200.7
.NET iOS	200.4 - 200.7
.NET Framework	200.4 - 200.7
UWP	200.4 - 200.7