Class GaugeRange
Represents value range along the scale. It is data object which suppose to be data context for the visual range representation.
Inherited Members
Namespace: Telerik.Windows.Controls.Gauge
Assembly: Telerik.Windows.Controls.DataVisualization.dll
Syntax
public class GaugeRange : RangeEventSource, IScaleObjectWithTooltip, INotifyPropertyChanged
Constructors
GaugeRange()
Initializes a new instance of the GaugeRange class.
Declaration
public GaugeRange()
Fields
BackgroundProperty
Identifies the Background dependency property.
Declaration
public static readonly DependencyProperty BackgroundProperty
Field Value
System.Windows.DependencyProperty
|
EndWidthProperty
Identifies the EndWidth dependency property.
Declaration
public static readonly DependencyProperty EndWidthProperty
Field Value
System.Windows.DependencyProperty
|
GeometryProperty
Identifies the Geometry dependency property.
Declaration
public static readonly DependencyProperty GeometryProperty
Field Value
System.Windows.DependencyProperty
|
IndicatorBackgroundProperty
Identifies the IndicatorBackground dependency property.
Declaration
public static readonly DependencyProperty IndicatorBackgroundProperty
Field Value
System.Windows.DependencyProperty
|
IndicatorColorMixSensitivityProperty
Identifies the IndicatorColorMixSensitivity dependency property.
Declaration
public static readonly DependencyProperty IndicatorColorMixSensitivityProperty
Field Value
System.Windows.DependencyProperty
|
LabelForegroundProperty
Identifies the LabelForeground dependency property.
Declaration
public static readonly DependencyProperty LabelForegroundProperty
Field Value
System.Windows.DependencyProperty
|
MaxProperty
Identifies the Max dependency property.
Declaration
public static readonly DependencyProperty MaxProperty
Field Value
System.Windows.DependencyProperty
|
MinProperty
Identifies the Min dependency property.
Declaration
public static readonly DependencyProperty MinProperty
Field Value
System.Windows.DependencyProperty
|
StartWidthProperty
Identifies the StartWidth dependency property.
Declaration
public static readonly DependencyProperty StartWidthProperty
Field Value
System.Windows.DependencyProperty
|
StrokeProperty
Identifies the Stroke dependency property.
Declaration
public static readonly DependencyProperty StrokeProperty
Field Value
System.Windows.DependencyProperty
|
StrokeThicknessProperty
Identifies the StrokeThickness dependency property.
Declaration
public static readonly DependencyProperty StrokeThicknessProperty
Field Value
System.Windows.DependencyProperty
|
TickBackgroundProperty
Identifies the TickBackground dependency property.
Declaration
public static readonly DependencyProperty TickBackgroundProperty
Field Value
System.Windows.DependencyProperty
|
TimeoutProperty
Identifies the Timeout dependency property.
Declaration
public static readonly DependencyProperty TimeoutProperty
Field Value
System.Windows.DependencyProperty
|
TitleProperty
Identifies the Title dependency property.
Declaration
public static readonly DependencyProperty TitleProperty
Field Value
System.Windows.DependencyProperty
|
TooltipFormatProperty
Identifies the TooltipFormat dependency property.
Declaration
public static readonly DependencyProperty TooltipFormatProperty
Field Value
System.Windows.DependencyProperty
|
ToolTipStyleProperty
Identifies the ToolTipStyle dependency property.
Declaration
public static readonly DependencyProperty ToolTipStyleProperty
Field Value
System.Windows.DependencyProperty
|
ToolTipTemplateProperty
Identifies the ToolTipTemplate dependency property.
Declaration
public static readonly DependencyProperty ToolTipTemplateProperty
Field Value
System.Windows.DependencyProperty
|
VisibilityProperty
Identifies the Visibility dependency property.
Declaration
public static readonly DependencyProperty VisibilityProperty
Field Value
System.Windows.DependencyProperty
|
Properties
Background
Gets or sets the background of the range's visual presentation.
Declaration
public Brush Background { get; set; }
Property Value
System.Windows.Media.Brush
|
Data
Return reference to self. This property can be used within Binding in XAML to implement binding which reflect extended property changes.
Declaration
public DependencyObject Data { get; }
Property Value
System.Windows.DependencyObject
|
EndWidth
Gets or sets the end width of the range bar.
Declaration
public double EndWidth { get; set; }
Property Value
System.Double
|
Geometry
This property serve internal RadGauge operations. It shouldn't be used in the customer code.
Declaration
public Geometry Geometry { get; set; }
Property Value
System.Windows.Media.Geometry
|
Remarks
Gets or sets range geometry.
IndicatorBackground
Gets or sets background of the indicator when it is in range.
Declaration
public Brush IndicatorBackground { get; set; }
Property Value
System.Windows.Media.Brush
|
IndicatorColorMixSensitivity
Gets or sets value which indicates the activity of color from previous range that is used to build indicator background.
Declaration
public double IndicatorColorMixSensitivity { get; set; }
Property Value
System.Double
|
Item[String]
Gets value from object using format string.
Declaration
public object this[string formatString] { get; }
Parameters
System.String
formatString
Format string. |
Property Value
System.Object
Formatted value. |
Remarks
The format string can use properties of the scale objects. For example "{Value|F2} Range: Min={Range.Min|F2} Max={Range.Max|F2}". This format string uses value of the indicator and Min and Max properties of the gauge range this indicator is pointing to. Currently you can use Range and Scale objects in the format string. The '|' character is used to separate property name and its output format.
LabelForeground
Gets or sets the foreground of labels are in range.
Declaration
public Brush LabelForeground { get; set; }
Property Value
System.Windows.Media.Brush
|
Max
Gets or sets the maximum value of the range.
Declaration
public double Max { get; set; }
Property Value
System.Double
|
Min
Gets or sets the minimum value of the range.
Declaration
public double Min { get; set; }
Property Value
System.Double
|
StartWidth
Gets or sets the start width of the range bar.
Declaration
public double StartWidth { get; set; }
Property Value
System.Double
|
Stroke
Gets or sets the Brush that specifies how the range outline is painted.
Declaration
public Brush Stroke { get; set; }
Property Value
System.Windows.Media.Brush
|
StrokeThickness
Gets or sets stroke thickness.
Declaration
public double StrokeThickness { get; set; }
Property Value
System.Double
|
TickBackground
Gets or sets background of ticks are in range.
Declaration
public Brush TickBackground { get; set; }
Property Value
System.Windows.Media.Brush
|
Timeout
Gets or sets timeout during which value should be in range to fire "In Range Timeout" event.
Declaration
public TimeSpan Timeout { get; set; }
Property Value
System.TimeSpan
|
Title
Gets or sets title of the range which can be used in the tooltip. Can be accessed as {Binding Path=Data[Range.Title]}.
Declaration
public string Title { get; set; }
Property Value
System.String
|
TooltipFormat
Gets or sets the format of the range tooltip.
Declaration
public string TooltipFormat { get; set; }
Property Value
System.String
|
Remarks
The format string can use properties of the scale objects. For example "{Value|F2} Range: Min={Range.Min|F2} Max={Range.Max|F2}". This format string uses value of the indicator and Min and Max properties of the gauge range this indicator is pointing to. Currently you can use Range and Scale objects in the format string. The '|' character is used to separate property name and its output format.
ToolTipStyle
Gets or sets the style applied to the toolTip of the range.
Declaration
public Style ToolTipStyle { get; set; }
Property Value
System.Windows.Style
|
ToolTipTemplate
Gets or sets template of the range's tooltip.
Declaration
public DataTemplate ToolTipTemplate { get; set; }
Property Value
System.Windows.DataTemplate
|
Visibility
Gets or sets visibility of the gauge range.
Declaration
public Visibility Visibility { get; set; }
Property Value
System.Windows.Visibility
|
Methods
InRange(DependencyObject)
Check whether given object is in range.
Declaration
public bool InRange(DependencyObject valueObject)
Parameters
System.Windows.DependencyObject
valueObject
Dependency object which have attachable ScaleObject.Value property set or indicator. |
Returns
System.Boolean
true if indicator's or object's value is in range. |
RaiseDataPropertyChanged()
Raise property changed event for "Data" property.
Declaration
public void RaiseDataPropertyChanged()
ValueInRange(Double)
Check whether given double value is in range.
Declaration
public bool ValueInRange(double value)
Parameters
System.Double
value
Value to test. |
Returns
System.Boolean
The value is in range. |
Events
PropertyChanged
Occurs when property changed. Implemented for binding.
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler
|