Back to Devexpress

ArcScale Members

corelibraries-devexpress-dot-xtragauges-dot-core-dot-model-dot-arcscale-dot-underscore-members.md

latest22.4 KB
Original Source

ArcScale Members

Represents the base class for scales within circular gauges.

Constructors

NameDescription
ArcScale()Initializes a new instance of the ArcScale class.
ArcScale(String)Initializes a new instance of the ArcScale class.

Properties

NameDescription
AngleGets or sets the angle, measured in degrees, at which the current object is displayed. Inherited from BaseLeafPrimitive.
AppearanceProvides access to appearance settings of the scale.
AutoRescalingGets or sets whether the scale’s range of values is automatically expanded when the scale’s current Value reaches either the ArcScale.MinValue or ArcScale.MaxValue.
BoundElementNameThis property supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive.
CenterGets or sets the center of the scale arc.
CustomLogarithmicBaseGets or sets a value specifying a logarithmic base when the ArcScale.Logarithmic property is set to true and ArcScale.LogarithmicBase is set to LogarithmicBase.Custom.
EnabledGets or sets whether the object is enabled. Inherited from BaseLeafPrimitive.
EndAngleGets or sets the angle at which the scale ends.
HitTestEnabledGets or sets whether the hit-testing feature is enabled for the current object. Inherited from BaseLeafPrimitive.
IsAnimatingGets a value indicating that the arc scale is currently being animated.
IsDiscreteThis property is reserved for future use.
IsDisposingGets whether the form is currently being disposed of. Inherited from BaseObject.
IsEmptyGets whether the current object is identical to the some predefined empty ArcScale object.
IsLogarithmicThis property is reserved for future use.
IsTransformLockedGets whether the object has been locked by the BaseLeafPrimitive.BeginTransform method. Inherited from BaseLeafPrimitive.
IsUpdateLockedGets whether the object has been locked for updating. Inherited from BaseObject.
IsXtraSerializingThis property supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive.
LabelsProvides access to the collection of text labels displayed on the same layer as the current scale.
LocationGets or sets the object’s location. Inherited from BaseLeafPrimitive.
LogarithmicGets or sets a value indicating whether the axis should display its numerical values using a logarithmic scale.
LogarithmicBaseGets or sets a value specifying a logarithmic base when the ArcScale.Logarithmic property is enabled.
MajorTickCountGets or sets the total number of major tickmarks displayed on a circular scale.
MajorTickmarkProvides access to major tick marks’ display options.
MaxValueGets or sets the maximum value of the circular scale.
MinorTickCountGets or sets the number of minor tickmarks on the scale between adjacent major tickmarks.
MinorTickmarkProvides access to minor tick marks’ display options.
MinValueGets or sets the minimum value of the circular scale.
NeedleVectorIdentifies the current direction of a vector pointing to the current value.
ParentCollectionNameThis property supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive.
ParentNameThis property supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive.
PercentGets the percent of the current value, in relation to the scale’s minimum and maximum values.
RadiusXGets or sets the X radius of the scale arc.
RadiusYGets or sets the Y radius of the scale arc.
RangesProvides access to the collection of custom ranges with which you can mark specific value ranges along the scale.
RenderableGets or sets whether the object can be rendered on a graphics surface. Inherited from BaseLeafPrimitive.
RescalingBestValuesEnables an algorithm for smart adjustment of the ArcScale.MinValue and ArcScale.MaxValue properties when the ArcScale.AutoRescaling property is set to true.
RescalingThresholdMaxSpecifies the threshold, in percents, where the automatic correction of the ArcScale.MaxValue takes place. This property is in effect if the ArcScale.AutoRescaling property is set to true.
RescalingThresholdMinSpecifies the threshold, in percents, where the automatic correction of the ArcScale.MinValue takes place. This property is in effect if the ArcScale.AutoRescaling property is set to true.
ScaleFactorGets or sets the object’s scale along the X and Y axes. Inherited from BaseLeafPrimitive.
ScaleLengthGets the length of the scale.
ShaderGets or sets an object that allows the color of the object to be modified. Inherited from BaseLeafPrimitive.
ShapesGets the collection of inner elements of the current object. Inherited from BaseLeafPrimitive.
StartAngleGets or sets the angle at which the scale starts.
TickCountGets the total number of major and minor tick marks on the scale.
TransformGets or sets the transformation matrix. Inherited from BaseLeafPrimitive.
TypeNameExThis property supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive.
UseColorSchemeGets or sets whether this scale should use Color Schemes.
ValueGets or sets the scale’s current value.
ZOrderGets or sets the Z-Order of the object. Inherited from BaseLeafPrimitive.

Methods

NameDescription
Assign(ArcScale)Copies settings of the specified object to the current object.
BeginTransform()Prevents the transformation of the BaseLeafPrimitive object from being performed until the EndTransform method is called. Inherited from BaseLeafPrimitive.
CalcHitInfo(Point)Retrieves information on the object’s inner element, located under the specified point. Inherited from BaseLeafPrimitive.
CancelTransform()Unlocks the object after the BeginTransform method has been called, without performing transformation. Inherited from BaseLeafPrimitive.
CreateLabel()Creates a label object of the type that is compatible with the current ArcScale object.
CreateRange()Creates a range object of the type that is compatible with the current ArcScale object.
Dispose()Disposes the BaseObject object. Inherited from BaseObject.
EndTransform()Unlocks the BaseLeafPrimitive object after the BeginUpdate method call and performs object transformation. Inherited from BaseLeafPrimitive.
Equals(Object, Object) staticDetermines 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.
GetInternalValue()Gets the actual value that has been assigned to the scale.
GetType()Gets the Type of the current instance. Inherited from Object.
IsDifferFrom(ArcScale)Returns whether the current object has different settings than the specified one.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
PercentToPoint(Single)Converts the specified percent value to the corresponding point along the scale.
PercentToValue(Single)Converts the specified percent to a value.
PointToPercent(PointF)Converts a point to a percent value.
PointToValue(PointF)
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ResetTransform()Resets the object’s location, rotation angle and scale factor. Inherited from BaseLeafPrimitive.
ToString()Returns a string that represents the current object. Inherited from Object.
ValueToPercent(Single)Returns the percent of the specified value in relation to the scale’s minimum and maximum values.
WaitForPendingDelayedCalculation()For internal use only. Inherited from BaseLeafPrimitive.
XtraCreateLabelsItem(XtraItemEventArgs)This member supports the internal infrastructure and is not intended to be used directly from your code.
XtraCreateRangesItem(XtraItemEventArgs)This member supports the internal infrastructure and is not intended to be used directly from your code.
XtraCreateShader(XtraItemEventArgs)This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive.

Events

NameDescription
AnimatingOccurs before the ArcScale object starts animation.
AnimationCompletedOccurs after the ArcScale object finishes animation.
ChangedOccurs after any property of the BaseObject object has been changed. Inherited from BaseObject.
CustomDrawElementOccurs before every gauge element is drawn, allowing you to draw it in a custom manner. Inherited from BaseLeafPrimitive.
CustomRescalingAllows you to implement a custom algorithm for adjusting the ArcScale.MinValue and ArcScale.MaxValue properties when the ArcScale.AutoRescaling property is set to true.
CustomTickmarkTextAllows you to dynamically customize the text of tickmarks.
DisposedOccurs after the BaseObject has been disposed of. Inherited from BaseObject.
GeometryChangedFires after any of the following properties has changed: ArcScale.Center, ArcScale.RadiusX, ArcScale.RadiusY, ArcScale.StartAngle or ArcScale.EndAngle.
MinMaxValueChangedFires when the value of the ArcScale.MinValue or ArcScale.MaxValue property is changed.
ValueChangedFires after the scale’s current value (ArcScale.Value) has been changed.

See Also

ArcScale Class

DevExpress.XtraGauges.Core.Model Namespace