ContextQMD
Back to Devexpress

GaugeControl Class

windowsforms-devexpress-dot-xtragauges-dot-win.md

latest7.2 KB
Original Source

GaugeControl Class

Allows you to create gauges of various types - circular, linear, digital and state indicators.

Namespace : DevExpress.XtraGauges.Win

Assembly : DevExpress.XtraGauges.v25.2.Win.dll

NuGet Package : DevExpress.Win.Gauges

Declaration

csharp
[ComVisible(false)]
[DXLicenseWinForms]
public class GaugeControl :
    GaugeControlBase,
    IToolTipControlClient,
    IAnyControlEdit2,
    IAnyControlEdit,
    ICloneable,
    ISupportJsonXtraSerializer,
    ISupportXtraSerializer
vb
<ComVisible(False)>
<DXLicenseWinForms>
Public Class GaugeControl
    Inherits GaugeControlBase
    Implements IToolTipControlClient,
               IAnyControlEdit2,
               IAnyControlEdit,
               ICloneable,
               ISupportJsonXtraSerializer,
               ISupportXtraSerializer

The following members return GaugeControl objects:

Remarks

This is the primary control of the XtraGauges Suite you initially work with. A Gauge Control can display one or multiple gauges at the same time, and gauges can be of the same or different types:

  • CircularGauge objects have a circular, semi-circular or any round scale. They are appropriate for creating speedometers, tachometers, stopwatches, clocks, etc.
  • LinearGauge objects are horizontally or vertically oriented bars with scales, appropriate for creating thermometers and progress displays.
  • DigitalGauge objects display text or numbers like LEDS do. Numbers can be painted using a 7 or 14 segment display style, and text can be painted using the 14 segment display style.
  • StateIndicatorGauge objects imitate static devices or simple indicators that have a fixed set of states.

To access gauges owned by a Gauge Control, use the control’s DevExpress.XtraGauges.Win.GaugeControlBase.Gauges property.

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:

csharp
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 and needle).
circularGauge.AddDefaultElements();
// Add non-default gauge element
circularGauge.AddSpindleCap();

// 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.MajorTickmark.TextOffset = -30;
scale.MinorTickCount = 3;
scale.MinorTickmark.ShapeType = TickmarkShapeType.Circular_Style2_1;
scale.AppearanceTickmarkText.TextBrush = new SolidBrushObject(Color.White);

// 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
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()
' Add non-default gauge element
circularGauge.AddSpindleCap()

' 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.MajorTickmark.TextOffset = -30
scale.MinorTickCount = 3
scale.MinorTickmark.ShapeType = TickmarkShapeType.Circular_Style2_1
scale.AppearanceTickmarkText.TextBrush = New SolidBrushObject(Color.White)

' 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

Inheritance

Object MarshalByRefObject Component Control DevExpress.XtraEditors.XtraControl ControlBase GaugeControlBase GaugeControl

See Also

GaugeControl Members

CircularGauge

LinearGauge

DigitalGauge

StateIndicatorGauge

Gauge Types

DevExpress.XtraGauges.Win Namespace