Class GraphicIndicator

Base class for needle, marker, bar, and state indicators.

Inheritance
System.Object
GraphicIndicator
InteractiveIndicator
NumericIndicator
StateIndicator
Namespace: Telerik.Windows.Controls.Gauge
Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

public class GraphicIndicator : Control, IThemable

Constructors

GraphicIndicator()

Declaration
public GraphicIndicator()

Fields

OffPositionProperty

Identifies the OffPosition dependency property.

Declaration
public static readonly DependencyProperty OffPositionProperty
Field Value
System.Windows.DependencyProperty

RefreshModeProperty

Identifies the RefreshMode dependency property.

Declaration
public static readonly DependencyProperty RefreshModeProperty
Field Value
System.Windows.DependencyProperty

RefreshRateProperty

Identifies the RefreshRate dependency property.

Declaration
public static readonly DependencyProperty RefreshRateProperty
Field Value
System.Windows.DependencyProperty

SnapIntervalProperty

Identifies the SnapInterval dependency property.

Declaration
public static readonly DependencyProperty SnapIntervalProperty
Field Value
System.Windows.DependencyProperty

SnapTypeProperty

Identifies the SnapType dependency property.

Declaration
public static readonly DependencyProperty SnapTypeProperty
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

UseRangeColorProperty

Identifies the UseRangeColor dependency property.

Declaration
public static readonly DependencyProperty UseRangeColorProperty
Field Value
System.Windows.DependencyProperty

ValueChangedEvent

Identifies the ValueChanged routed event.

Declaration
public static readonly RoutedEvent ValueChangedEvent
Field Value
System.Windows.RoutedEvent

ValueProperty

Identifies the Value dependency property.

Declaration
public static readonly DependencyProperty ValueProperty
Field Value
System.Windows.DependencyProperty

ValueSourceProperty

Identifies the ValueSource dependency property.

Declaration
public static readonly DependencyProperty ValueSourceProperty
Field Value
System.Windows.DependencyProperty

Properties

Data

Return reference to self. This property can be used within Binding in XAML to implement binding which reflect extended property changes.

Declaration
public IndicatorData Data { get; }
Property Value
IndicatorData

InternalAnimationStarted

Gets or sets value which indicates whether internal animation is started for this indicator.

Declaration
public bool InternalAnimationStarted { get; set; }
Property Value
System.Boolean

OffPosition

Gets or sets “OFF” position of the indicator. This is location where indicator will be parked to when its value is double.NaN.

Declaration
public double OffPosition { get; set; }
Property Value
System.Double

PlaybackFrame

Gets index of the current playback frame.

Declaration
public int PlaybackFrame { get; }
Property Value
System.Int32

RefreshMode

Gets or sets refresh mode of the indicator.

Declaration
public IndicatorRefreshMode RefreshMode { get; set; }
Property Value
IndicatorRefreshMode

RefreshRate

Gets or sets refresh rate of the indicator.

Declaration
public TimeSpan RefreshRate { get; set; }
Property Value
System.TimeSpan

RefreshTimer

This property serve internal needs of the RadGauge control.

Declaration
public IndicatorRefreshTimer RefreshTimer { get; set; }
Property Value
IndicatorRefreshTimer

Remarks

Gets or sets refresh timer for indicator refresh rate feature.

SnapInterval

Gets or sets snap interval for the indicator.

Declaration
public double SnapInterval { get; set; }
Property Value
System.Double

SnapType

Gets or sets snap type for the indicator.

Declaration
public SnapType SnapType { get; set; }
Property Value
SnapType

TooltipFormat

Gets or sets format of the indicator's 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 indicator.

Declaration
public Style ToolTipStyle { get; set; }
Property Value
System.Windows.Style

ToolTipTemplate

Gets or sets template of the indicator's tooltip.

Declaration
public DataTemplate ToolTipTemplate { get; set; }
Property Value
System.Windows.DataTemplate

UseRangeColor

Gets or sets value which indicates whether the indicator will use range color as its background.

Declaration
public bool UseRangeColor { get; set; }
Property Value
System.Boolean

Value

Gets or sets value of the indicator.

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

ValueMappings

Gets the value mappings that constitute the data mappings for a indicator.

Declaration
public IndicatorValueMappingCollection ValueMappings { get; }
Property Value
IndicatorValueMappingCollection

ValueSource

Gets or sets value source for the playback feature.

Declaration
public IEnumerable ValueSource { get; set; }
Property Value
System.Collections.IEnumerable

Methods

MoveNext()

Move to the next value in the value source.

Declaration
public bool MoveNext()
Returns
System.Boolean

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

MovePrevious()

Move to the previous value in the value source.

Declaration
public bool MovePrevious()
Returns
System.Boolean

true if the enumerator was successfully advanced to the previous element; false if the enumerator has passed the begin of the collection.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate.

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnValueChanged(Double, Double)

Called when indicator's value is changed.

Declaration
protected virtual void OnValueChanged(double oldValue, double newValue)
Parameters
System.Double oldValue

Old value.
System.Double newValue

New value.

Reset()

Move before the first value in the value source.

Declaration
public void Reset()

ResetTheme()

Resets the theme.

Declaration
public virtual void ResetTheme()

StartPlayback()

Playback content of the History or ValueSource.

Declaration
public void StartPlayback()

StartPlayback(PropertyChangedEventHandler)

Playback content of the History or ValueSource.

Declaration
public void StartPlayback(PropertyChangedEventHandler frameChanged)
Parameters
System.ComponentModel.PropertyChangedEventHandler frameChanged

Event handler for "FrameChanged" event on playback worker.

StopPlayback()

Stop playback content of the History or ValueSource.

Declaration
public void StopPlayback()

Events

ValueChanged

Occurs when the indicator's value is changed.

Declaration
public event RoutedPropertyChangedEventHandler<double> ValueChanged
Event Type
RoutedPropertyChangedEventHandler<System.Double>

Extension Methods