Skip to main content
All docs
V24.1

Measurements Members

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

Constructors

Name Description
Measurements() Initializes a new instance of the Measurements class.

Fields

Name Description
AreaUnitsProperty static Identifies the AreaUnits dependency property.
DistanceUnitsProperty static Identifies the DistanceUnits dependency property.
ModeProperty static Identifies the Mode dependency property.
ToolbarOptionsProperty static Identifies the ToolbarOptions dependency property.

Properties

Name Description
AreaUnits Gets or sets the measurement unit for an area ruler.
CanFreeze Gets a value that indicates whether the object can be made unmodifiable. Inherited from Freezable.
DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
Dispatcher Gets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
DistanceUnits Gets or sets measurement units for distance rulers.
IsFrozen Gets a value that indicates whether the object is currently modifiable. Inherited from Freezable.
IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
Mode Gets or sets the mode that the Measurements object uses.
RemoveRulersCommand Returns a command that removes all rulers from the map.
SetCreateModeCommand Returns the command that activates the Measurements object’s Create mode.
SetEditModeCommand Returns the command that activates the Measurements object’s Edit mode.
ToolbarOptions Returns the Measurements toolbar options.

Methods

Name Description
CheckAccess() Determines whether the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
ClearValue(DependencyProperty) Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. Inherited from DependencyObject.
ClearValue(DependencyPropertyKey) Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. Inherited from DependencyObject.
Clone() Creates a modifiable clone of the Freezable, making deep copies of the object’s values. When copying the object’s dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values. Inherited from Freezable.
CloneCore(Freezable) protected Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. Inherited from Freezable.
CloneCurrentValue() Creates a modifiable clone (deep copy) of the Freezable using its current values. Inherited from Freezable.
CloneCurrentValueCore(Freezable) protected Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. Inherited from Freezable.
CoerceValue(DependencyProperty) Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. Inherited from DependencyObject.
CreateInstance() protected Initializes a new instance of the Freezable class. Inherited from Freezable.
CreateRuler(RulerType, IList<CoordPoint>, RulerAppearance) Creates a ruler with the specified type and appearance settings 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 the 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 a provided DependencyObject is equivalent to the current DependencyObject. Inherited from DependencyObject.
Freeze() Makes the current object unmodifiable and sets its IsFrozen property to true. Inherited from Freezable.
Freeze(Freezable, Boolean) protected static If the isChecking parameter is true, this method indicates whether the specified Freezable can be made unmodifiable. If the isChecking parameter is false, this method attempts to make the specified Freezable unmodifiable and indicates whether the operation succeeded. Inherited from Freezable.
FreezeCore(Boolean) protected Makes the Freezable object unmodifiable or tests whether it can be made unmodifiable. Inherited from Freezable.
GetAsFrozen() Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. Inherited from Freezable.
GetAsFrozenCore(Freezable) protected Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. Inherited from Freezable.
GetCurrentValueAsFrozen() Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. Inherited from Freezable.
GetCurrentValueAsFrozenCore(Freezable) protected Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. Inherited from Freezable.
GetHashCode() Gets a hash code for this DependencyObject. Inherited from DependencyObject.
GetLocalValueEnumerator() Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. Inherited from DependencyObject.
GetType() Gets the Type of the current instance. Inherited from Object.
GetValue(DependencyProperty) Returns the current effective value of a dependency property on this instance of a DependencyObject. Inherited from DependencyObject.
InsertPoint(MapRuler, CoordPoint, Int32) Inserts a new point in the ruler.
InvalidateProperty(DependencyProperty) Re-evaluates the effective value for the specified dependency property. Inherited from DependencyObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnChanged() protected Called when the current Freezable object is modified. Inherited from Freezable.
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) protected This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. Inherited from Freezable.
OnFreezablePropertyChanged(DependencyObject, DependencyObject) protected Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. Inherited from Freezable.
OnPropertyChanged(DependencyPropertyChangedEventArgs) protected Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. Inherited from Freezable.
ReadLocalValue(DependencyProperty) Returns the local value of a dependency property, if it exists. Inherited from DependencyObject.
ReadPreamble() protected Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. Inherited from Freezable.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemovePoint(MapRuler, Int32) Removes the point with the specified index.
RemoveRuler(MapRuler) Removes the ruler passed as a parameter from the map.
RemoveRulers() Removes all rulers from the map.
SetCurrentValue(DependencyProperty, Object) Sets the value of a dependency property without changing its value source. Inherited from DependencyObject.
SetValue(DependencyProperty, Object) Sets the local value of a dependency property, specified by its dependency property identifier. Inherited from DependencyObject.
SetValue(DependencyPropertyKey, Object) Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. Inherited from DependencyObject.
ShouldSerializeProperty(DependencyProperty) protected Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. Inherited from DependencyObject.
ToString() Returns a string that represents the current object. Inherited from Object.
UpdatePoint(MapRuler, CoordPoint, Int32) Changes the coordinates of the point with the specified index.
VerifyAccess() Enforces that the calling thread has access to this DispatcherObject. Inherited from DispatcherObject.
WritePostscript() protected Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. Inherited from Freezable.
WritePreamble() protected Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. Inherited from Freezable.

Events

Name Description
AfterMeasurement Occurs after a user creates a ruler.
AfterRulerRemoval
BeforeMeasurement Occurs when a user starts ruler creation.
BeforeRulerRemoval
Changed Occurs when the Freezable or an object it contains is modified. Inherited from Freezable.
PropertyChanged Occurs every time any of the MapDependencyObject class properties has changed its value. Inherited from MapDependencyObject.
See Also