SetVertexSymbolOptions Method

In This Topic

Sets the symbol for a vertex while sketching. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void SetVertexSymbolOptions( 
   VertexSymbolType symbolType,
   VertexSymbolOptions vertexSymbol
)

Public Sub SetVertexSymbolOptions( _
   ByVal symbolType As VertexSymbolType, _
   ByVal vertexSymbol As VertexSymbolOptions _
)

Parameters

symbolType: The type of vertex symbol to obtain.
vertexSymbol: The new vertex symbol.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentException	Symbol options are not valid. See CanSetVertexSymbolOptions for details on option settings.

Remarks

This method calls the CanSetVertexSymbolOptions function prior to setting the symbol values. If the options are invalid, no updates are made to the symbol.

Example

Set Sketch Vertex Symbol Options

//var options = ApplicationOptions.EditingOptions;
QueuedTask.Run(() =>
{
  //change the regular unselected vertex symbol
  //default is a green, hollow, square, 5pts. Change to
  //Blue outline diamond, 10 pts
  var vertexSymbol = new VertexSymbolOptions(VertexSymbolType.RegularUnselected);
  vertexSymbol.OutlineColor = ColorFactory.Instance.BlueRGB;
  vertexSymbol.MarkerType = VertexMarkerType.Diamond;
  vertexSymbol.Size = 10;

  //Are these valid?
  if (options.CanSetVertexSymbolOptions(
       VertexSymbolType.RegularUnselected, vertexSymbol)) {
    //apply them
    options.SetVertexSymbolOptions(VertexSymbolType.RegularUnselected, vertexSymbol);
          }
});

Set Sketch Vertex Symbol Back to Default

//var options = ApplicationOptions.EditingOptions;
QueuedTask.Run(() =>
{
  //ditto for reg selected and current selected, unselected
  var def_reg_unsel = 
    options.GetDefaultVertexSymbolOptions(VertexSymbolType.RegularUnselected);
  //apply default
  options.SetVertexSymbolOptions(
    VertexSymbolType.RegularUnselected, def_reg_unsel);
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

EditingOptions Class
EditingOptions Members

Send feedback