CanSetVertexSymbolOptions Method

In This Topic

Determines if the vertex sketch symbol can be set.

Syntax

C#
Visual Basic (Declaration)

public bool CanSetVertexSymbolOptions( 
   VertexSymbolType symbolType,
   VertexSymbolOptions vertexSymbol
)

Public Function CanSetVertexSymbolOptions( _
   ByVal symbolType As VertexSymbolType, _
   ByVal vertexSymbol As VertexSymbolOptions _
) As Boolean

Parameters

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

Return Value

True if the vertex symbol options are valid. False otherwise.

Remarks

This function should be called prior to SetVertexSymbolOptions to ensure the parameters are valid. It checks the following

Outline width can be null or a positive number (ie greater than 0)
Size can be null or a positive number (ie greater than 0)
Angle rotation can be null or between -360 and 360

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);
          }
});

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

EditingOptions Class
EditingOptions Members

Send feedback