Class ScaleBase

Represents the abstract base class for the Scale, used in Gauges.

Inheritance

System.Object

GaugeElement

LocalizableGaugeElement

ScaleBase

CircularScale

LinearScale

Inherited Members

LocalizableGaugeElement.LocationProperty

LocalizableGaugeElement.OnLocationChanged(DependencyPropertyChangedEventArgs)

LocalizableGaugeElement.Location

LocalizableGaugeElement.LocationChanged

GaugeElement.BackgroundBrushProperty

GaugeElement.BorderBrushProperty

GaugeElement.BorderWidthProperty

GaugeElement.BackgroundBrush

GaugeElement.BorderBrush

GaugeElement.BorderWidth

Namespace: Syncfusion.Windows.Gauge

Assembly: Syncfusion.Gauge.WPF.dll

Syntax

public abstract class ScaleBase : LocalizableGaugeElement

Constructors

ScaleBase()

Declaration

protected ScaleBase()

Fields

IsNumberDivisionProperty

Identifies the IsNumberDivision dependency property.

Declaration

public static readonly DependencyProperty IsNumberDivisionProperty

Field Value

Type	Description
System.Windows.DependencyProperty

MajorIntervalValueProperty

Identifies the MajorIntervalValue dependency property.

Declaration

public static readonly DependencyProperty MajorIntervalValueProperty

Field Value

Type	Description
System.Windows.DependencyProperty

MaximumProperty

Identifies the Maximum dependency property.

Declaration

public static readonly DependencyProperty MaximumProperty

Field Value

Type	Description
System.Windows.DependencyProperty

MinimumProperty

Identifies the Minimum dependency property.

Declaration

public static readonly DependencyProperty MinimumProperty

Field Value

Type	Description
System.Windows.DependencyProperty

MinorIntervalValueProperty

Identifies the MinorIntervalValue dependency property.

Declaration

public static readonly DependencyProperty MinorIntervalValueProperty

Field Value

Type	Description
System.Windows.DependencyProperty

NumberMajorDivisionProperty

Identifies the NumberMajorDivision dependency property.

Declaration

public static readonly DependencyProperty NumberMajorDivisionProperty

Field Value

Type	Description
System.Windows.DependencyProperty

NumberMinorDivisionProperty

Identifies the NumberMinorDivision dependency property.

Declaration

public static readonly DependencyProperty NumberMinorDivisionProperty

Field Value

Type	Description
System.Windows.DependencyProperty

ScaleBarSizeProperty

Identifies the Minimum dependency property.

Declaration

public static readonly DependencyProperty ScaleBarSizeProperty

Field Value

Type	Description
System.Windows.DependencyProperty

ScaleDirectionProperty

Identifies the ScaleDirection dependency property.

Declaration

public static readonly DependencyProperty ScaleDirectionProperty

Field Value

Type	Description
System.Windows.DependencyProperty

ShadowOffsetProperty

Identifies the ShadowOffset dependency property.

Declaration

public static readonly DependencyProperty ShadowOffsetProperty

Field Value

Type	Description
System.Windows.DependencyProperty

Properties

IsNumberDivision

Gets or sets the boolean value to set the number division for Ticks. This is a dependency property.

Declaration

public bool IsNumberDivision { get; set; }

Property Value

Type	Description
System.Boolean	Type: System.Double Default value is false.

MajorIntervalValue

Gets or sets the interval between the major ticks. This is a dependency property.

Declaration

public double MajorIntervalValue { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 0.

Maximum

Gets or sets the maximum value that can be displayed in the scale. This is a dependency property.

Declaration

public double Maximum { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 0.

Remarks

Maximum should be set before Minimum value. Since Minimum should not be greater than Maximum value.

Minimum

Gets or sets the minimum value that can be displayed in the scale. This is a dependency property.

Declaration

public double Minimum { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 0.

Remarks

Minimum should be set after Maximum value is set. Since Minimum should not be greater than Maximum value.

MinorIntervalValue

Gets or sets the interval between the minor ticks. This is a dependency property.

Declaration

public double MinorIntervalValue { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 0.

NumberMajorDivision

Gets or sets the value to set the number major division. This is a dependency property.

Declaration

public double NumberMajorDivision { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 0.

NumberMinorDivision

Gets or sets the value to set the number division for Ticks. This is a dependency property.

Declaration

public double NumberMinorDivision { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is false.

Ranges

Gets or sets a Collection of ranges.

Declaration

public RangesCollection Ranges { get; set; }

Property Value

Type	Description
RangesCollection	Type: RangesCollection

ScaleBarSize

Gets or sets the width of the scale. This is a dependency property.

Declaration

public double ScaleBarSize { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 0.

ScaleDirection

Gets or sets the ScaleDirection of scale. This is a dependency property.

Declaration

public ScaleDirection ScaleDirection { get; set; }

Property Value

Type	Description
ScaleDirection	Type: System.Double Default value is Clockwise direction.

ShadowOffset

Gets or sets the offset of element's shadow. This is a dependency property.

Declaration

public double ShadowOffset { get; set; }

Property Value

Type	Description
System.Double	Type: System.Double Default value is 0.

Ticks

Gets or sets a Collection of ticks.

Declaration

public TicksCollection Ticks { get; set; }

Property Value

Type	Description
TicksCollection	Type: TicksCollection

Methods

CoerceMaximum(Object)

Fulfils the logic before setting the value of Maximum dependency property.

Declaration

protected virtual object CoerceMaximum(object value)

Parameters

Type	Name	Description
System.Object	value	The value that should be corrected.

Returns

Type	Description
System.Object	The corrected value.

CoerceMaximum(DependencyObject, Object)

Coerces the value of the Maximum property.

Declaration

public static object CoerceMaximum(DependencyObject d, object value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	d	The ScaleBase object.
System.Object	value	The instance containing the event data.

Returns

Type	Description
System.Object	The checked value.

CoerceMinimum(Object)

Fulfils the logic before setting the value of Minimum dependency property.

Declaration

protected virtual object CoerceMinimum(object value)

Parameters

Type	Name	Description
System.Object	value	The value that should be corrected.

Returns

Type	Description
System.Object	The corrected value.

CoerceMinimum(DependencyObject, Object)

Coerces the value of the Minimum property.

Declaration

public static object CoerceMinimum(DependencyObject d, object value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	d	The ScaleBase object.
System.Object	value	The instance containing the event data.

Returns

Type	Description
System.Object	The checked value.

CoerceScaleBarSize(Object)

Fulfils the logic before setting the value of ScaleBarSize dependency property.

Declaration

protected virtual object CoerceScaleBarSize(object value)

Parameters

Type	Name	Description
System.Object	value	The value that should be corrected.

Returns

Type	Description
System.Object	The corrected value.

CoerceScaleBarSize(DependencyObject, Object)

Coerces the value of the ScaleBarSize property.

Declaration

public static object CoerceScaleBarSize(DependencyObject d, object value)

Parameters

Type	Name	Description
System.Windows.DependencyObject	d	The ScaleBase object.
System.Object	value	The instance containing the event data.

Returns

Type	Description
System.Object	The checked value.

OnMajorIntervalValueChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises MajorIntervalValueChanged event.

Declaration

protected virtual void OnMajorIntervalValueChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property change details, such as old value and new value.

OnMaximumChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises MaximumChanged event.

Declaration

protected virtual void OnMaximumChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property change details, such as old value and new value.

OnMinimumChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises MinimumChanged event.

Declaration

protected virtual void OnMinimumChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property change details, such as old value and new value.

OnMinorIntervalValueChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises MinorIntervalValueChanged event.

Declaration

protected virtual void OnMinorIntervalValueChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property change details, such as old value and new value.

OnScaleBarSizeChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises ScaleBarSizeChanged event.

Declaration

protected virtual void OnScaleBarSizeChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property change details, such as old value and new value.

OnScaleDirectionChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises ScaleBarSizeChanged event.

Declaration

protected virtual void OnScaleDirectionChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property change details, such as old value and new value.

OnShadowOffsetChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises ShadowOffsetChanged event.

Declaration

protected virtual void OnShadowOffsetChanged(DependencyPropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.Windows.DependencyPropertyChangedEventArgs	e	Property change details, such as old value and new value.

Events

MajorIntervalValueChanged

Event that is raised when MajorIntervalValue property is changed.

Declaration

public event PropertyChangedCallback MajorIntervalValueChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

MaximumChanged

Event that is raised when Maximum property is changed.

Declaration

public event PropertyChangedCallback MaximumChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

MinimumChanged

Event that is raised when Minimum property is changed.

Declaration

public event PropertyChangedCallback MinimumChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

MinorIntervalValueChanged

Event that is raised when MinorIntervalValue property is changed.

Declaration

public event PropertyChangedCallback MinorIntervalValueChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

ScaleBarSizeChanged

Event that is raised when ScaleBarSize property is changed.

Declaration

public event PropertyChangedCallback ScaleBarSizeChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

ScaleDirectionChanged

Event that is raised when IsReversed property is changed.

Declaration

public event PropertyChangedCallback ScaleDirectionChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback

ShadowOffsetChanged

Event that is raised when ShadowOffset property is changed.

Declaration

public event PropertyChangedCallback ShadowOffsetChanged

Event Type

Type	Description
System.Windows.PropertyChangedCallback