Class CircularGauge

Represents the CircularGauge UI element.

Inheritance
System.Object
GaugeBase
CircularGauge
OlapCircularGauge
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.Windows.Gauge
Assembly: Syncfusion.Gauge.WPF.dll
Syntax
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
[SkinType]
public class CircularGauge : GaugeBase, IDisposable
Remarks

Circular gauges are perfect for presenting values of a specific range. It can be used to create sophisticated gaming applications, dashboards, clocks, industrial equipments and many more.In short it could be used for almost anything one could ever imagine of, for representing a range of values in Circular form. Circular gauge can accommodate multiple scales, pointers, ranges, state indicators, labels and images.It has a virtual bounded rectangle around it. The top-left corner of the virtual bounded rectangle is represented by the co-ordinate(0, 0) and that of the bottom-right is represented by (100, 100).Each and every gauge element is drawn inside the bounded rectangle based on the location property.

Constructors

CircularGauge()

Initializes a new instance of the CircularGauge class.

Declaration
public CircularGauge()

Fields

FrameTypeProperty

Identifies the FrameType dependency property.

Declaration
public static readonly DependencyProperty FrameTypeProperty
Field Value
Type
System.Windows.DependencyProperty

HalfCircleInnerRadiusProperty

Identifies the HalfCircleInnerRadius dependency property.

Declaration
public static readonly DependencyProperty HalfCircleInnerRadiusProperty
Field Value
Type
System.Windows.DependencyProperty

HalfCircleInnerSweepDirectionProperty

Identifies the HalfCircleInnerSweepDirection dependency property.

Declaration
public static readonly DependencyProperty HalfCircleInnerSweepDirectionProperty
Field Value
Type
System.Windows.DependencyProperty

HalfCircleSweepDirectionProperty

Identifies the HalfCircleSweepDirection dependency property.

Declaration
public static readonly DependencyProperty HalfCircleSweepDirectionProperty
Field Value
Type
System.Windows.DependencyProperty

RadiusProperty

Identifies the Radius dependency property.

Declaration
public static readonly DependencyProperty RadiusProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

FrameType

Gets or sets the CircularGauge's FrameType. This is a dependency property.

Declaration
public GaugeFrameType FrameType { get; set; }
Property Value
Type Description
GaugeFrameType

Type: GaugeFrameType

HalfCircleInnerRadius

Gets or sets the inner radius of the HalfCircle style CircularGauge. This is a dependency property.

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

Type: System.Double Default value is 15.

HalfCircleInnerSweepDirection

Gets or sets the inner half circle's sweep direction for HalfCircle style CircularGauge. This is a dependency property.

Declaration
public SweepDirection HalfCircleInnerSweepDirection { get; set; }
Property Value
Type Description
System.Windows.Media.SweepDirection

Type: System.Windows.Media.SweepDirection Default value is System.Windows.Media.SweepDirection.Counterclockwise

HalfCircleSweepDirection

Gets or sets the sweep direction of the HalfCircle style CircularGauge. This is a dependency property.

Declaration
public SweepDirection HalfCircleSweepDirection { get; set; }
Property Value
Type Description
System.Windows.Media.SweepDirection

Type: System.Windows.Media.SweepDirection Default value is System.Windows.Media.SweepDirection.Clockwise
Remarks

CouuterclockWise halfcircle can be obtained by setting the FrameType Property to CounterClockwiseHalfCircle. This Property is Obsolete.

LabelTickStyle

LabelTickStyle

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

MajorTickStyle

MajorTickStyle

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

MinorTickStyle

MinorTickStyle

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

PointerCapStyle

PointerCapStyle

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

PointerStyle

PointerStyle

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

Radius

Gets or sets the radius of the CircularGauge. This is a dependency property.

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

Type: System.Double Default value is 150.

Scales

Gets or sets a collection of circular scales.

Declaration
public ScaleCollection Scales { get; set; }
Property Value
Type Description
ScaleCollection

Type: ScaleCollection

Methods

CircularGaugeLoaded(Object, RoutedEventArgs)

Invoked when the control is ready for presentation.

Declaration
protected virtual void CircularGaugeLoaded(object sender, RoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Windows.RoutedEventArgs e

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

CollectionChanged(Object, NotifyCollectionChangedEventArgs)

Occurs when an item is added, removed, changed, moved, or the entire collection is refreshed.

Declaration
protected override void CollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The System.Collections.Specialized.NotifyCollectionChangedEventArgs that contains the event data.
Overrides

Dispose()

Declaration
public void Dispose()

OnApplyTemplate()

Builds the current template's visual tree if necessary.

Declaration
public override void OnApplyTemplate()
Overrides

OnFrameTypeChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises FrameTypeChanged event.

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

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

OnInitialized(EventArgs)

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

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

The System.EventArgs that contains the event data.
Overrides

OnRadiusChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises RadiusChanged event.

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

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

OnRenderSizeChanged(SizeChangedInfo)

Called when the size of the Circular Gauge changes.

Declaration
protected override void OnRenderSizeChanged(SizeChangedInfo sizeInfo)
Parameters
Type Name Description
System.Windows.SizeChangedInfo sizeInfo

Details of the old and new size involved in the change.
Overrides

RefreshAdornerLayer()

Refreshes the adorner layer.

Declaration
protected override void RefreshAdornerLayer()
Overrides

RefreshBorders()

Updates CircularGauge frames.

Declaration
protected override void RefreshBorders()
Overrides

Events

FrameTypeChanged

Event that is raised when FrameType property is changed.

Declaration
public event PropertyChangedCallback FrameTypeChanged
Event Type
Type
System.Windows.PropertyChangedCallback

RadiusChanged

Event that is raised when Radius property is changed.

Declaration
public event PropertyChangedCallback RadiusChanged
Event Type
Type
System.Windows.PropertyChangedCallback

Implements

System.IDisposable

See Also