LinearScale Members
Represents the base class for scales in linear gauges.Constructors
| Name | Description |
|---|---|
| LinearScale() | Initializes a new instance of the LinearScale class. |
| LinearScale(String) | Initializes a new instance of the LinearScale class. |
Properties
| Name | Description |
|---|---|
| Angle | Gets or sets the angle, measured in degrees, at which the current object is displayed. Inherited from BaseLeafPrimitive. |
| Appearance | Provides access to appearance settings of the scale. |
| AutoRescaling | Gets or sets whether the scale’s range of values is automatically expanded when the scale’s current Value reaches either the LinearScale.MinValue or LinearScale.MaxValue. |
| BoundElementName | This property supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive. |
| CustomLogarithmicBase | Gets 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. |
| Enabled | Gets or sets whether the object is enabled. Inherited from BaseLeafPrimitive. |
| EndPoint | Gets or sets the ending point of the scale. |
| HitTestEnabled | Gets or sets whether the hit-testing feature is enabled for the current object. Inherited from BaseLeafPrimitive. |
| IsAnimating | Gets a value indicating that the linear scale is currently being animated. |
| IsDiscrete | This property is reserved for future use. |
| IsDisposing | Gets whether the form is currently being disposed of. Inherited from BaseObject. |
| IsEmpty | Gets whether the current object is identical to the some predefined empty LinearScale object. |
| IsLogarithmic | This property is reserved for future use. |
| IsTransformLocked | Gets whether the object has been locked by the BaseLeafPrimitive.BeginTransform method. Inherited from BaseLeafPrimitive. |
| IsUpdateLocked | Gets whether the object has been locked for updating. Inherited from BaseObject. |
| IsXtraSerializing | This property supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive. |
| Labels | Provides access to the collection of text labels displayed on the same layer as the current scale. |
| Location | Gets or sets the object’s location. Inherited from BaseLeafPrimitive. |
| Logarithmic | Gets or sets a value indicating whether the axis should display its numerical values using a logarithmic scale. |
| LogarithmicBase | Gets or sets a value specifying a logarithmic base when the LinearScale.Logarithmic property is enabled. |
| MajorTickCount | Gets or sets the total number of major tickmarks displayed on a linear scale. |
| MajorTickmark | Provides access to major tick marks’ display options. |
| MaxValue | Gets or sets the maximum value of the linear scale. |
| MinorTickCount | Gets or sets the number of minor tickmarks on the scale between adjacent major tickmarks. |
| MinorTickmark | Provides access to minor tick marks’ display options. |
| MinValue | Gets or sets the minimum value of the linear scale. |
| ParentCollectionName | This property supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive. |
| ParentName | This property supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive. |
| Percent | Gets the percent of the current value, in relation to the scale’s minimum and maximum values. |
| Ranges | Provides access to the collection of custom ranges with which you can mark specific value ranges along the scale. |
| Renderable | Gets or sets whether the object can be rendered on a graphics surface. Inherited from BaseLeafPrimitive. |
| RescalingBestValues | Enables an algorithm for smart adjustment of the LinearScale.MinValue and LinearScale.MaxValue properties when the LinearScale.AutoRescaling property is set to true. |
| RescalingThresholdMax | Specifies the threshold, in percents, where the automatic correction of the LinearScale.MaxValue takes place. This property is in effect if the LinearScale.AutoRescaling property is set to true. |
| RescalingThresholdMin | Specifies the threshold, in percents, where the automatic correction of the LinearScale.MinValue takes place. This property is in effect if the LinearScale.AutoRescaling property is set to true. |
| ScaleFactor | Gets or sets the object’s scale along the X and Y axes. Inherited from BaseLeafPrimitive. |
| ScaleLength | Gets the length of the scale, determined by its minimum and maximum value. |
| Shader | Gets or sets an object that allows the color of the object to be modified. Inherited from BaseLeafPrimitive. |
| Shapes | Gets the collection of inner elements of the current object. Inherited from BaseLeafPrimitive. |
| StartPoint | Gets or sets the starting point of the scale. |
| TickCount | Gets the total number of major and minor tick marks on the scale. |
| Transform | Gets or sets the transformation matrix. Inherited from BaseLeafPrimitive. |
| TypeNameEx | This property supports the internal infrastructure and is not intended to be used directly from your code. Inherited from BaseLeafPrimitive. |
| UseColorScheme | Gets or sets whether this scale should use Color Schemes. |
| Value | Gets or sets the scale’s current value. |
| ZOrder | Gets or sets the Z-Order of the object. Inherited from BaseLeafPrimitive. |
Methods
| Name | Description |
|---|---|
| Assign(LinearScale) | 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 LinearScale object. |
| CreateRange() | Creates a range object of the type that is compatible with the current LinearScale 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) 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. |
| GetInternalValue() | Gets the actual value that has been assigned to the scale. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| IsDifferFrom(LinearScale) | Returns whether the current object has different settings than the specified one. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| PercentToPoint(Single) | Converts the specified percent value to the corresponding point along the scale, between the LinearScale.StartPoint and LinearScale.EndPoint. |
| PercentToValue(Single) | Converts the specified percent to a value. |
| PointToPercent(PointF) | Converts the specified point along the scale to the corresponding percent value in relation to the LinearScale.StartPoint and LinearScale.EndPoint. |
| PointToValue(PointF) | |
| ReferenceEquals(Object, Object) static | Determines 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
| Name | Description |
|---|---|
| Animating | Occurs before the LinearScale object starts animation. |
| AnimationCompleted | Occurs after the LinearScale object finishes animation. |
| Changed | Occurs after any property of the BaseObject object has been changed. Inherited from BaseObject. |
| CustomDrawElement | Occurs before every gauge element is drawn, allowing you to draw it in a custom manner. Inherited from BaseLeafPrimitive. |
| CustomRescaling | Allows you to implement a custom algorithm for adjusting the LinearScale.MinValue and LinearScale.MaxValue properties when the LinearScale.AutoRescaling property is set to true. |
| CustomTickmarkText | Allows you to dynamically customize the text of tickmarks. |
| Disposed | Occurs after the BaseObject has been disposed of. Inherited from BaseObject. |
| GeometryChanged | Fires after any of the following properties has changed: LinearScale.StartPoint or LinearScale.EndPoint. |
| MinMaxValueChanged | Fires when the value of the LinearScale.MinValue or LinearScale.MaxValue property is changed. |
| ValueChanged | Fires after the scale’s current value has been changed. |
See Also