ToolOptions Class—ArcGIS Pro

ToolOptions Class

In This Topic

Property collection that may be serialized to the CIM as a Template Tool's Options

Syntax

C#
Visual Basic (Declaration)

public sealed class ToolOptions : System.Collections.Generic.ICollection<KeyValuePair<string,object>>, System.Collections.Generic.ICollection<KeyValuePair<TKey,TValue>>, System.Collections.Generic.IDictionary<string,object>, System.Collections.Generic.IEnumerable<KeyValuePair<string,object>>, System.Collections.Generic.IEnumerable<KeyValuePair<TKey,TValue>>, System.Collections.Generic.IEnumerable<T>, System.Collections.IEnumerable, System.Collections.Specialized.INotifyCollectionChanged, System.ComponentModel.INotifyPropertyChanged, System.IDisposable

Public NotInheritable Class ToolOptions 
   Implements System.Collections.Generic.ICollection(Of KeyValuePair(Of String,Object)), System.Collections.Generic.ICollection(Of KeyValuePair(Of TKey,TValue)), System.Collections.Generic.IDictionary(Of String,Object), System.Collections.Generic.IEnumerable(Of KeyValuePair(Of String,Object)), System.Collections.Generic.IEnumerable(Of KeyValuePair(Of TKey,TValue)), System.Collections.Generic.IEnumerable(Of T), System.Collections.IEnumerable, System.Collections.Specialized.INotifyCollectionChanged, System.ComponentModel.INotifyPropertyChanged, System.IDisposable

Remarks

For the object values, only string and numeric types are supported for serialization, though currently there are no checks.

Listening to the CollectionChanged event provides a way to share ToolOptions between a Tool and its corresponding ToolOptions EmbeddableControl.

Inheritance Hierarchy

System.Object
ArcGIS.Desktop.Editing.ToolOptions

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

ToolOptions Members
ArcGIS.Desktop.Editing Namespace

Send feedback