CircularGauge Class

Represents a gauge that can have a circular, semi-circular or any round scale.

Namespace: DevExpress.XtraGauges.Win.Gauges.Circular

Assembly: DevExpress.XtraGauges.v18.1.Win.dll

Declaration

C#

public class CircularGauge :
    BaseGaugeWin,
    ICircularGauge,
    IWinGauge

VB.NET

Public Class CircularGauge
    Inherits BaseGaugeWin
    Implements ICircularGauge,
               IWinGauge

Related API Members

The following members accept/return CircularGauge objects:

• GaugeControlBase.AddCircularGauge()

Remarks

Circular gauges can be displayed as a part of a GaugeControl.

Circular gauges are appropriate for creating speedometers, tachometers, stopwatches, clocks, etc. The following image shows a set of circular gauges painted using various paint styles:

To specify the range of values displayed by a scale, use the ArcScale.MinValue and ArcScale.MaxValue properties. To specify the value to be indicated by a needle, associate the needle with a specific scale via its ArcScale property, and then set the value via the ArcScale.Value property.

See Circular Gauges to learn more.

Example

The following example shows how to create a circular gauge.

In the example, a circular gauge is created using the GaugeControlBase.AddCircularGauge method. The default elements (a scale, background layer, needle and spindle cap) are added to the circular gauge via the CircularGauge.AddDefaultElements method. Then, some of them are customized in a specific manner.

The result is displayed below:

C#

using DevExpress.XtraGauges.Win;
using DevExpress.XtraGauges.Win.Gauges.Circular;
using DevExpress.XtraGauges.Core.Model;

GaugeControl gc = new GaugeControl();

// Add a circular gauge.
CircularGauge circularGauge = gc.AddCircularGauge();

// Add the default elements (a scale, background layer, needle and spindle cap).
circularGauge.AddDefaultElements();

// Change the background layer's paint style.
ArcScaleBackgroundLayer background = circularGauge.BackgroundLayers[0];
background.ShapeType = BackgroundLayerShapeType.CircularFull_Style3;

// Customize the scale's settings.
ArcScaleComponent scale = circularGauge.Scales[0];
scale.MinValue = 0;
scale.MaxValue = 100;
scale.Value = 25;
scale.MajorTickCount = 6;
scale.MajorTickmark.FormatString = "{0:F0}";
scale.MajorTickmark.ShapeType = TickmarkShapeType.Circular_Style2_2;
scale.MajorTickmark.ShapeOffset = -9;
scale.MajorTickmark.AllowTickOverlap = true;
scale.MinorTickCount = 3;
scale.MinorTickmark.ShapeType = TickmarkShapeType.Circular_Style2_1;

// Change the needle's paint style.
ArcScaleNeedleComponent needle = circularGauge.Needles[0];
needle.ShapeType = NeedleShapeType.CircularFull_Style3;

// Add the gauge control to the form.
gc.Size = new Size(250, 250);
gc.Parent = this;

VB.NET

Imports DevExpress.XtraGauges.Win
Imports DevExpress.XtraGauges.Win.Gauges.Circular
Imports DevExpress.XtraGauges.Core.Model

Private gc As GaugeControl = New GaugeControl()

' Add a circular gauge.
Private circularGauge As CircularGauge = gc.AddCircularGauge()

' Add the default elements (a scale, background layer, needle and spindle cap).
circularGauge.AddDefaultElements()

' Change the background layer's paint style.
Dim background As ArcScaleBackgroundLayer = circularGauge.BackgroundLayers(0)
background.ShapeType = BackgroundLayerShapeType.CircularFull_Style3

' Customize the scale's settings.
Dim scale As ArcScaleComponent = circularGauge.Scales(0)
scale.MinValue = 0
scale.MaxValue = 100
scale.Value = 25
scale.MajorTickCount = 6
scale.MajorTickmark.FormatString = "{0:F0}"
scale.MajorTickmark.ShapeType = TickmarkShapeType.Circular_Style2_2
scale.MajorTickmark.ShapeOffset = -9
scale.MajorTickmark.AllowTickOverlap = True
scale.MinorTickCount = 3
scale.MinorTickmark.ShapeType = TickmarkShapeType.Circular_Style2_1

' Change the needle's paint style.
Dim needle As ArcScaleNeedleComponent = circularGauge.Needles(0)
needle.ShapeType = NeedleShapeType.CircularFull_Style3

' Add the gauge control to the form.
gc.Size = New Size(250, 250)
gc.Parent = Me

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CircularGauge class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-add-custom-ranges-to-the-arcscale-in-code-win-e1457/CS/Q205964/Form1.cs#L23

GaugeControl gaugeControl = new GaugeControl();
CircularGauge gauge = (CircularGauge)gaugeControl.AddGauge(GaugeType.Circular);
gauge.AddDefaultElements();

how-to-use-gaugecontrol-as-an-in-place-editor-e1172/CS/InplageGaugeControl/Form1.cs#L18

GaugeControl gaugeControl;
CircularGauge circularGauge;
void CreateGaugeFromCode(Theme theme) {

VB.NET

how-to-add-custom-ranges-to-the-arcscale-in-code-win-e1457/VB/Q205964/Form1.vb#L25

Dim gaugeControl As New GaugeControl()
Dim gauge As CircularGauge = CType(gaugeControl.AddGauge(GaugeType.Circular), CircularGauge)
gauge.AddDefaultElements()

how-to-use-gaugecontrol-as-an-in-place-editor-e1172/VB/InplageGaugeControl/Form1.vb#L22

Private gaugeControl As GaugeControl
Private circularGauge As CircularGauge
Private Sub CreateGaugeFromCode(ByVal theme As Theme)

Inheritance

Object

MarshalByRefObject

Component

BaseGauge

BaseGaugeWin

CircularGauge