Click or drag to resize

SketchEditorStartAsync Method (Geometry, SketchCreationMode, SketchEditConfiguration)

Starts to edit Geometry based on specified SketchCreationMode and SketchEditConfiguration.

Namespace:  Esri.ArcGISRuntime.UI
Assembly:  Esri.ArcGISRuntime (in Esri.ArcGISRuntime.dll) Version: 100.11.0
Syntax
public Task<Geometry> StartAsync(
	Geometry geometry,
	SketchCreationMode creationMode,
	SketchEditConfiguration editConfiguration
)

Parameters

geometry
Type: Esri.ArcGISRuntime.GeometryGeometry
The geometry to edit.
creationMode
Type: Esri.ArcGISRuntime.UISketchCreationMode
Determines how geometry will be modified.
editConfiguration
Type: Esri.ArcGISRuntime.UISketchEditConfiguration
Defines which edit capabilities will be enabled.

Return Value

Type: TaskGeometry
A task that represents the asynchronous sketching of geometry. The value of the task result is a Geometry object.
Remarks

Each time one of the StartAsync methods is called on the SketchEditor, it creates a default SketchEditConfiguration with parameters that make sense for that particular shape (e.g. circles are scaled in an aspect-ratio-preserving way, but ellipses are not). The intended use of the EditConfiguration property is to override these defaults after each StartAsync call, to modify the defaults based on context. You can use any one of the StartAsync overloaded methods which accepts a SketchEditConfiguration parameter, or modify the EditConfiguration after calling StartAsync.

See Also