Skip to main content
All docs
V23.2

Measurements Members

Contains API to manage rulers that help users measure distances and areas on a map.

Properties

Name Description
AreaUnits Gets or sets measurement units for area rulers.
DistanceUnits Gets or sets measurement units for distance rulers.
ShowToolbar Specifies whether the Measurements toolbar is displayed.
Style Returns ruler style options.
ToolbarOptions Returns the Measurements toolbar options.

Methods

Name Description
CreateRuler(RulerType, IList<CoordPoint>, MapRulerStyle) Creates a ruler with the specified style and type to measure the distance or the area between coordinate points passed as the second parameter.
CreateRuler(RulerType, IList<CoordPoint>) Creates a ruler of the specified type to measure distance or area between coordinate points passed as the second parameter.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
InsertPoint(MapRuler, CoordPoint, Int32) Inserts a new point in the ruler.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemovePoint(MapRuler, Int32) Removes a point with the specified index.
RemoveRuler(MapRuler) Removes the ruler passed as a parameter from the map.
RemoveRulers() Removes all rulers from the map.
SetCreateMode(RulerType) Activates the Measurements object’s Create mode.
SetEditMode() Enables Edit mode of the Measurements object.
ToString() Returns the short class name enclosed in parentheses.
UpdatePoint(MapRuler, CoordPoint, Int32) Changes the coordinates of a point with the specified index.

Events

Name Description
AfterMeasurement Occurs after a user creates a ruler.
AfterRulerRemoval
BeforeMeasurement Occurs when a user starts ruler creation.
BeforeRulerRemoval
See Also