menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class RangeBase - API Reference

    Show / Hide Table of Contents

    Class RangeBase

    Represents the abstract base class for the Ranges used in Gauge.

    Inheritance
    System.Object
    GaugeElement
    RangeBase
    CircularRange
    LinearRange
    Inherited Members
    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 RangeBase : GaugeElement

    Constructors

    RangeBase()

    Declaration
    protected RangeBase()

    Fields

    BindIndicatorProperty

    Identifies the BindIndicator dependency property.

    Declaration
    public static readonly DependencyProperty BindIndicatorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    DistanceFromScaleProperty

    Identifies the DistanceFromScale dependency property.

    Declaration
    public static readonly DependencyProperty DistanceFromScaleProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    EndValueProperty

    Identifies the EndValue dependency property.

    Declaration
    public static readonly DependencyProperty EndValueProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    EndWidthProperty

    Identifies the EndWidth dependency property.

    Declaration
    public static readonly DependencyProperty EndWidthProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    IndicatorColorProperty

    Identifies the BindIndicator dependency property.

    Declaration
    public static readonly DependencyProperty IndicatorColorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    RangePositionProperty

    Identifies the RangePosition dependency property.

    Declaration
    public static readonly DependencyProperty RangePositionProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    StartValueProperty

    Identifies the StartValue dependency property.

    Declaration
    public static readonly DependencyProperty StartValueProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    StartWidthProperty

    Identifies the StartWidth dependency property.

    Declaration
    public static readonly DependencyProperty StartWidthProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    Properties

    BindIndicator

    Gets or sets the width of the range at its start. This is a dependency property.

    Declaration
    public bool BindIndicator { get; set; }
    Property Value
    Type Description
    System.Boolean

    Type: System.Boolean Default value is false.

    See Also
    BindIndicator

    DistanceFromScale

    Gets or sets the distance between the range and the scale. This is a dependency property.

    Declaration
    public double DistanceFromScale { get; set; }
    Property Value
    Type Description
    System.Double

    Type: System.Double Default value is 0.

    EndValue

    Gets or sets the end value of the range. This is a dependency property.

    Declaration
    public double EndValue { get; set; }
    Property Value
    Type Description
    System.Double

    Type: System.Double Default value is 0.

    Remarks

    The Range's EndValue should be specified before the StartValue, because of the constraint, that StartValue should be lesser than the EndValue

    See Also
    StartValue

    EndWidth

    Gets or sets the width of the range at its end. This is a dependency property.

    Declaration
    public double EndWidth { get; set; }
    Property Value
    Type Description
    System.Double

    Type: System.Double Default value is 0.

    See Also
    StartWidth

    IndicatorColor

    Gets or sets the indicator color of the range. This is a dependency property.

    Declaration
    public Brush IndicatorColor { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    Type: System.Windows.Media.Brush Default value is false.

    RangePosition

    Gets or sets the placement of the range relatively to the scale. This is a dependency property.

    Declaration
    public ScalePlacement RangePosition { get; set; }
    Property Value
    Type Description
    ScalePlacement

    Type: System.Double Default value is ScalePlacement.Inside.

    StartValue

    Gets or sets the start value of the range. This is a dependency property.

    Declaration
    public double StartValue { get; set; }
    Property Value
    Type Description
    System.Double

    Type: System.Double Default value is 0.

    Remarks

    The Range's StartValue should be specified after the EndValue, because of the constraint, that EndValue should be greater than the StartValue

    See Also
    EndValue

    StartWidth

    Gets or sets the width of the range at its start. This is a dependency property.

    Declaration
    public double StartWidth { get; set; }
    Property Value
    Type Description
    System.Double

    Type: System.Double Default value is 0.

    See Also
    EndWidth

    Methods

    CoerceEndValue(Object)

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

    Declaration
    protected virtual object CoerceEndValue(object value)
    Parameters
    Type Name Description
    System.Object value

    The value that should be corrected.

    Returns
    Type Description
    System.Object

    The corrected value.

    CoerceEndValue(DependencyObject, Object)

    Coerces the value of the EndValue property.

    Declaration
    public static object CoerceEndValue(DependencyObject d, object value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject d

    The RangeBase object.

    System.Object value

    The instance containing the event data.

    Returns
    Type Description
    System.Object

    The checked value.

    CoerceStartValue(Object)

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

    Declaration
    protected virtual object CoerceStartValue(object value)
    Parameters
    Type Name Description
    System.Object value

    The value that should be corrected.

    Returns
    Type Description
    System.Object

    The corrected value.

    CoerceStartValue(DependencyObject, Object)

    Coerces the value of the StartValue property.

    Declaration
    public static object CoerceStartValue(DependencyObject d, object value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject d

    The RangeBase object.

    System.Object value

    The instance containing the event data.

    Returns
    Type Description
    System.Object

    The checked value.

    OnBindIndicatorChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises StartValueChanged event.

    Declaration
    protected virtual void OnBindIndicatorChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property change details, such as old value and new value.

    OnDistanceFromScaleChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises DistanceFromScaleChanged event.

    Declaration
    protected virtual void OnDistanceFromScaleChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property change details, such as old value and new value.

    OnEndValueChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises EndValueChanged event.

    Declaration
    protected virtual void OnEndValueChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property change details, such as old value and new value.

    OnEndWidthChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises EndWidthChanged event.

    Declaration
    protected virtual void OnEndWidthChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property change details, such as old value and new value.

    OnIndicatorColorChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises IndicatorColorChanged event.

    Declaration
    protected virtual void OnIndicatorColorChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property change details, such as old value and new value.

    OnRangePositionChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises RangePositionChanged event.

    Declaration
    protected virtual void OnRangePositionChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property change details, such as old value and new value.

    OnStartValueChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises StartValueChanged event.

    Declaration
    protected virtual void OnStartValueChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property change details, such as old value and new value.

    OnStartWidthChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises StartWidthChanged event.

    Declaration
    protected virtual void OnStartWidthChanged(DependencyPropertyChangedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DependencyPropertyChangedEventArgs e

    Property change details, such as old value and new value.

    Events

    BindIndicatorChanged

    Event that is raised when BindIndicator property is changed.

    Declaration
    public event PropertyChangedCallback BindIndicatorChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    DistanceFromScaleChanged

    Event that is raised when DistanceFromScale property is changed.

    Declaration
    public event PropertyChangedCallback DistanceFromScaleChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    EndValueChanged

    Event that is raised when EndValue property is changed.

    Declaration
    public event PropertyChangedCallback EndValueChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    EndWidthChanged

    Event that is raised when EndWidth property is changed.

    Declaration
    public event PropertyChangedCallback EndWidthChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    IndicatorColorChanged

    Event that is raised when IndicatorColor property is changed.

    Declaration
    public event PropertyChangedCallback IndicatorColorChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    RangePositionChanged

    Event that is raised when RangePosition property is changed.

    Declaration
    public event PropertyChangedCallback RangePositionChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    StartValueChanged

    Event that is raised when StartValue property is changed.

    Declaration
    public event PropertyChangedCallback StartValueChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback

    StartWidthChanged

    Event that is raised when StartWidth property is changed.

    Declaration
    public event PropertyChangedCallback StartWidthChanged
    Event Type
    Type Description
    System.Windows.PropertyChangedCallback
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved