Class LinearGauge

Linear gauges displays values graphically along a linear scale It comes with sophisticated support to provide endless possibilities for customization. With Essential Gauge, users can display several data ranges in a concise and compact area. Data in the control can be easily depicted and quickly understood by users of any level.

Inheritance
System.Object
BaseControl
LinearGauge
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.Windows.Forms.Gauge
Assembly: Syncfusion.Gauge.Windows.dll
Syntax
public class LinearGauge : BaseControl, IThemeProvider, IVisualStyle, IDisposable

Constructors

LinearGauge()

Initializes a new instance of LinearGauge class.

Declaration
public LinearGauge()

Properties

BackColor

Gets or sets the background color.

Declaration
public override Color BackColor { get; set; }
Property Value
Type
System.Drawing.Color

BackgroundGradientEndColor

Gets or sets the end color of the gradient inner background.

Declaration
public Color BackgroundGradientEndColor { get; set; }
Property Value
Type
System.Drawing.Color

BackgroundGradientStartColor

Gets or sets the start color of the gradient inner background.

Declaration
public Color BackgroundGradientStartColor { get; set; }
Property Value
Type
System.Drawing.Color

BackgroundImage

Specifies theBackgroundImage for the control.

Declaration
public override Image BackgroundImage { get; }
Property Value
Type
System.Drawing.Image

BackgroundImageLayout

Specifies the image layout for the BackgroundImage.

Declaration
public override ImageLayout BackgroundImageLayout { get; }
Property Value
Type
System.Windows.Forms.ImageLayout

ChannelBounds

Gets bounds of channel.

Declaration
protected virtual Rectangle ChannelBounds { get; }
Property Value
Type
System.Drawing.Rectangle

DataManager

Gets the CurrencyManager of the bound list.

Declaration
protected CurrencyManager DataManager { get; }
Property Value
Type
System.Windows.Forms.CurrencyManager

DataMember

Specifies a secondary list of Datasource, to display it

Declaration
public string DataMember { get; set; }
Property Value
Type
System.String

DataSource

Gets or sets the DataSource that you want to display the data.

Declaration
public object DataSource { get; set; }
Property Value
Type
System.Object

DisplayMember

Indicates the property to display for the items in this control.

Declaration
public string DisplayMember { get; set; }
Property Value
Type
System.String

DisplayRecordIndex

Gets or Sets the display record index

Declaration
public int DisplayRecordIndex { get; set; }
Property Value
Type
System.Int32

Font

Overrides the base class font property.

Declaration
public override Font Font { get; set; }
Property Value
Type
System.Drawing.Font

ForeColor

Gets or sets the foreground color which is used to display the text.

Declaration
public override Color ForeColor { get; set; }
Property Value
Type
System.Drawing.Color

GaugeBaseColor

Gets or sets the value indicating the base line color.

Declaration
[Obsolete("Use ScaleColor property, instead of this")]
public Color GaugeBaseColor { get; set; }
Property Value
Type
System.Drawing.Color

GaugelabelFont

Specifies font for GaugeLabel.

Declaration
public Font GaugelabelFont { get; set; }
Property Value
Type
System.Drawing.Font

IncrementValue

Declaration
public int IncrementValue { get; set; }
Property Value
Type
System.Int32

InnerFrameGradientEndColor

Gets or sets the end gradient color for the inner frame.

Declaration
public Color InnerFrameGradientEndColor { get; set; }
Property Value
Type
System.Drawing.Color

InnerFrameGradientStartColor

Gets or sets the start gradient color for the inner frame.

Declaration
public Color InnerFrameGradientStartColor { get; set; }
Property Value
Type
System.Drawing.Color

LinearFrameType

Gets or sets the value indicating the LinearFrameType.

Declaration
public LinearFrameType LinearFrameType { get; set; }
Property Value
Type
LinearFrameType

MajorDifference

Gets or sets the value to divide the ticks from minimum to maximum value.

Declaration
public int MajorDifference { get; set; }
Property Value
Type
System.Int32

MajorTickMarkColor

Gets or sets the value indicating MajorTickMarkColor.

Declaration
public Color MajorTickMarkColor { get; set; }
Property Value
Type
System.Drawing.Color

MajorTicksHeight

Gets or sets the value to specify the maximum height for the MajorTicks.

Declaration
public int MajorTicksHeight { get; set; }
Property Value
Type
System.Int32

MaximumValue

Gets or Sets the MaximumValue to display.

Declaration
public float MaximumValue { get; set; }
Property Value
Type
System.Single

MinimumValue

Gets or sets the MinimumValue to display.

Declaration
public float MinimumValue { get; set; }
Property Value
Type
System.Single

MinorTickCount

Gets or Sets the value to specify the number of MinorTicks to be drawn in the control.

Declaration
public int MinorTickCount { get; set; }
Property Value
Type
System.Int32

MinorTickHeight

Gets or sets the value to specify the maximum height for the minor ticks.

Declaration
public int MinorTickHeight { get; set; }
Property Value
Type
System.Int32

MinorTickMarkColor

Gets or sets the value indicating MinorTickMarkColor.

Declaration
public Color MinorTickMarkColor { get; set; }
Property Value
Type
System.Drawing.Color

NeedleColor

Gets or sets the value indicating the Needle Color.

Declaration
public Color NeedleColor { get; set; }
Property Value
Type
System.Drawing.Color

OuterFrameGradientEndColor

Gets or sets the end gradient color for the outer frame.

Declaration
public Color OuterFrameGradientEndColor { get; set; }
Property Value
Type
System.Drawing.Color

OuterFrameGradientStartColor

Gets or sets the start gradient color for the outer frame.

Declaration
public Color OuterFrameGradientStartColor { get; set; }
Property Value
Type
System.Drawing.Color

PointerBounds

Gets bounds of Pointer.

Declaration
protected virtual Rectangle PointerBounds { get; }
Property Value
Type
System.Drawing.Rectangle

PointerPlacement

Gets or sets the value indicating the PointerPlacement.

Declaration
public Placement PointerPlacement { get; set; }
Property Value
Type
Placement

Ranges

Returns the GaugeRanges of the control.

Declaration
public LinearRangeCollection Ranges { get; }
Property Value
Type
LinearRangeCollection

ReadOnly

Gets or sets whether Linear Gauge value can be updated using mouse selection.

Declaration
public bool ReadOnly { get; set; }
Property Value
Type
System.Boolean
Remarks

The Gauge value will be updated on drag and drop operation and mouse click on required Gauge value

Renderer

Gets or sets the Custom Renderer.

Declaration
public ILinearGaugeRenderer Renderer { get; set; }
Property Value
Type
ILinearGaugeRenderer

ScaleColor

Gets or sets the value indicating the base line color.

Declaration
public Color ScaleColor { get; set; }
Property Value
Type
System.Drawing.Color

ScaleLabelColor

Gets or sets the color for numeric labels.

Declaration
public Color ScaleLabelColor { get; set; }
Property Value
Type
System.Drawing.Color

ShowNeedle

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

ShowScaleLabel

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

ThemeBrush

Gets the ThemeBrush ColorTable for LinearGauge control

Declaration
public BindingList<LinearGaugeThemeBrush> ThemeBrush { get; }
Property Value
Type
System.ComponentModel.BindingList<LinearGaugeThemeBrush>

ThemeStyle

Gets or sets the LinearGaugeVisualStyle value used to customize the appearance of the LinearGauge.

Declaration
public LinearGaugeVisualStyle ThemeStyle { get; set; }
Property Value
Type
LinearGaugeVisualStyle
Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

Value

Gets or sets the Value to be displayed.

Declaration
public float Value { get; set; }
Property Value
Type
System.Single

ValueIndicatorColor

Gets or sets the color for ValueIndicator.

Declaration
public Color ValueIndicatorColor { get; set; }
Property Value
Type
System.Drawing.Color

VisualStyle

Specifies the VisualStyle.

Declaration
public ThemeStyle VisualStyle { get; set; }
Property Value
Type
ThemeStyle

Methods

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type
System.Windows.Forms.AccessibleObject

Dispose(Boolean)

Dispose function overrides

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

GetControlName(String)

Helps to apply the ControlName settings in control

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName
Returns
Type
System.String
Overrides

OnBindingContextChanged(EventArgs)

Raises the System.Windows.Forms.Control.BindingContextChanged event.

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

EventArgs that contains the EventData

OnCanApplyThemeChanged(Boolean)

Helps to apply the CanApplyTheme settings in control

Declaration
public override void OnCanApplyThemeChanged(bool canApplyTheme)
Parameters
Type Name Description
System.Boolean canApplyTheme
Overrides

OnCanOverrideStyleChanged(Boolean)

Helps to apply the CanOverriderStyle settings in control

Declaration
public override void OnCanOverrideStyleChanged(bool canOverriderStyle)
Parameters
Type Name Description
System.Boolean canOverriderStyle
Overrides

OnMouseCaptureChanged(EventArgs)

Handles release of mouse capture.

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

EventArgs that contains the event data.

OnMouseDown(MouseEventArgs)

Raises the MouseDown event

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

The MouseEventArgs that contains the event data.

OnMouseMove(MouseEventArgs)

Raises the MouseMove event

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

The MouseEventArgs that contains the event data.

OnMouseUp(MouseEventArgs)

Raises the MouseUp event

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

The MouseEventArgs that contains the event data.

OnPaint(PaintEventArgs)

Overrides base.OnPaint

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

OnSizeChanged(EventArgs)

Initialized the size changed event.

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

OnThemeNameChanged(String)

Helps to apply the ThemeName settings in control

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

ThemeName
Overrides

RepaintControl()

Repaints the control

Declaration
public void RepaintControl()

ResetBackgroundGradientEndColor()

Resets the BackgroundGradientEndColor property to it's default value.

Declaration
protected void ResetBackgroundGradientEndColor()

ResetBackgroundGradientStartColor()

Resets the BackgroundGradientStartColor property to it's default value.

Declaration
protected void ResetBackgroundGradientStartColor()

ResetDisplayRecordIndex()

Resets the DisplayRecordIndex property to it's default value.

Declaration
protected void ResetDisplayRecordIndex()

ResetFrameType()

Resets the property to it's default value.

Declaration
protected void ResetFrameType()

ResetGaugeBaseColor()

Resets the ScaleColor property to it's default value.

Declaration
protected void ResetGaugeBaseColor()

ResetIncrementValue()

Resets the IncrementValue property to it's default value.

Declaration
public void ResetIncrementValue()

ResetInnerFrameGradientEndColor()

Resets the InnerFrameGradientEndColor property to it's default value.

Declaration
protected void ResetInnerFrameGradientEndColor()

ResetInnerFrameGradientStartColor()

Resets the InnerFrameGradientStartColor property to it's default value.

Declaration
protected void ResetInnerFrameGradientStartColor()

ResetMajorDifference()

Resets the MajorDifference property to it's default value.

Declaration
protected void ResetMajorDifference()

ResetMajorTickMarkColor()

Resets the MajorTickMarkColor property to it's default value.

Declaration
protected void ResetMajorTickMarkColor()

ResetMajorTickMarkHeight()

Resets the MajorTicksHeight property to it's default value.

Declaration
protected void ResetMajorTickMarkHeight()

ResetMaximumValue()

Resets the MaximumValue property to it's default value.

Declaration
protected void ResetMaximumValue()

ResetMinimumValue()

Resets the MinimumValue property to it's default value.

Declaration
protected void ResetMinimumValue()

ResetMinorTickMarkColor()

Resets the MinorTickMarkColor property to it's default value.

Declaration
protected void ResetMinorTickMarkColor()

ResetMinorTickMarkHeight()

Resets the MinorTickHeight property to it's default value.

Declaration
protected void ResetMinorTickMarkHeight()

ResetNeedleColor()

Resets the NeedleColor property to it's default value.

Declaration
protected void ResetNeedleColor()

ResetOuterFrameGradientEndColor()

Resets the OuterFrameGradientEndColor property to it's default value.

Declaration
protected void ResetOuterFrameGradientEndColor()

ResetOuterFrameGradientStartColor()

Resets the OuterFrameGradientStartColor property to it's default value.

Declaration
protected void ResetOuterFrameGradientStartColor()

ResetPointerPlacement()

Resets the PointerPlacement property to it's default value.

Declaration
protected void ResetPointerPlacement()

ResetReadOnly()

Resets the ReadOnly property to it's default value.

Declaration
public void ResetReadOnly()

ResetScaleLabelColor()

Resets the ScaleLabelColor property to it's default value.

Declaration
protected void ResetScaleLabelColor()

ResetShowNeedle()

Resets the ShowNeedle property to it's default value.

Declaration
protected void ResetShowNeedle()

ResetValue()

Resets the Value property to it's default value.

Declaration
protected void ResetValue()

ResetValueIndicatorColor()

Resets the ValueIndicatorColor property to it's default value.

Declaration
protected void ResetValueIndicatorColor()

ResetVisualStyle()

Resets the VisualStyle property to it's default value.

Declaration
protected void ResetVisualStyle()

ShouldSerializeBackColor()

Indicates whether the current value of the BackColor property is to be serialized.

Declaration
protected bool ShouldSerializeBackColor()
Returns
Type
System.Boolean

ShouldSerializeBackgroundGradientEndColor()

Indicates whether the current value of the BackgroundGradientEndColor property is to be serialized.

Declaration
protected bool ShouldSerializeBackgroundGradientEndColor()
Returns
Type
System.Boolean

ShouldSerializeBackgroundGradientStartColor()

Indicates whether the current value of the BackgroundGradientStartColor property is to be serialized.

Declaration
protected bool ShouldSerializeBackgroundGradientStartColor()
Returns
Type
System.Boolean

ShouldSerializeDisplayRecordIndex()

Indicates whether the current value of the DisplayRecordIndex property is to be serialized.

Declaration
protected bool ShouldSerializeDisplayRecordIndex()
Returns
Type
System.Boolean

ShouldSerializeFrameType()

Indicates whether the current value of the property is to be serialized.

Declaration
protected bool ShouldSerializeFrameType()
Returns
Type
System.Boolean

ShouldSerializeGaugeBaseColor()

Indicates whether the current value of the ScaleColor property is to be serialized.

Declaration
protected bool ShouldSerializeGaugeBaseColor()
Returns
Type
System.Boolean

ShouldSerializeIncrementValue()

Indicates whether the current value of the IncrementValue property is to be serialized.

Declaration
protected bool ShouldSerializeIncrementValue()
Returns
Type
System.Boolean

ShouldSerializeInnerFrameGradientEndColor()

Indicates whether the current value of the InnerFrameGradientEndColor property is to be serialized.

Declaration
protected bool ShouldSerializeInnerFrameGradientEndColor()
Returns
Type
System.Boolean

ShouldSerializeInnerFrameGradientStartColor()

Indicates whether the current value of the InnerFrameGradientStartColor property is to be serialized.

Declaration
protected bool ShouldSerializeInnerFrameGradientStartColor()
Returns
Type
System.Boolean

ShouldSerializeMajorDifference()

Indicates whether the current value of the MajorDifference property is to be serialized.

Declaration
protected bool ShouldSerializeMajorDifference()
Returns
Type
System.Boolean

ShouldSerializeMajorTickMarkColor()

Indicates whether the current value of the MajorTickMarkColor property is to be serialized.

Declaration
protected bool ShouldSerializeMajorTickMarkColor()
Returns
Type
System.Boolean

ShouldSerializeMajorTicksHeight()

Indicates whether the current value of the MajorTicksHeight property is to be serialized.

Declaration
protected bool ShouldSerializeMajorTicksHeight()
Returns
Type
System.Boolean

ShouldSerializeMaximumValue()

Indicates whether the current value of the MaximumValue property is to be serialized.

Declaration
protected bool ShouldSerializeMaximumValue()
Returns
Type
System.Boolean

ShouldSerializeMinimumValue()

Indicates whether the current value of the MinimumValue property is to be serialized.

Declaration
protected bool ShouldSerializeMinimumValue()
Returns
Type
System.Boolean

ShouldSerializeMinorTickHeight()

Indicates whether the current value of the MinorTickHeight property is to be serialized.

Declaration
protected bool ShouldSerializeMinorTickHeight()
Returns
Type
System.Boolean

ShouldSerializeMinorTickMarkColor()

Indicates whether the current value of the MinorTickMarkColor property is to be serialized.

Declaration
protected bool ShouldSerializeMinorTickMarkColor()
Returns
Type
System.Boolean

ShouldSerializeNeedleColor()

Indicates whether the current value of the NeedleColor property is to be serialized.

Declaration
protected bool ShouldSerializeNeedleColor()
Returns
Type
System.Boolean

ShouldSerializeOuterFrameGradientEndColor()

Indicates whether the current value of the OuterFrameGradientEndColor property is to be serialized.

Declaration
protected bool ShouldSerializeOuterFrameGradientEndColor()
Returns
Type
System.Boolean

ShouldSerializeOuterFrameGradientStartColor()

Indicates whether the current value of the OuterFrameGradientStartColor property is to be serialized.

Declaration
protected bool ShouldSerializeOuterFrameGradientStartColor()
Returns
Type
System.Boolean

ShouldSerializeReadOnly()

Indicates whether the current value of the ReadOnly property is to be serialized.

Declaration
protected bool ShouldSerializeReadOnly()
Returns
Type
System.Boolean

ShouldSerializeScaleLabelColor()

Indicates whether the current value of the ScaleLabelColor property is to be serialized.

Declaration
protected bool ShouldSerializeScaleLabelColor()
Returns
Type
System.Boolean

ShouldSerializeShowNeedle()

Indicates whether the current value of the ShowNeedle property is to be serialized.

Declaration
protected bool ShouldSerializeShowNeedle()
Returns
Type
System.Boolean

ShouldSerializeShowScaleLabel()

Indicates whether the current value of the ShowScaleLabel property is to be serialized.

Declaration
protected bool ShouldSerializeShowScaleLabel()
Returns
Type
System.Boolean

ShouldSerializeTickPlacement()

Indicates whether the current value of the property is to be serialized.

Declaration
protected bool ShouldSerializeTickPlacement()
Returns
Type
System.Boolean

ShouldSerializeValue()

Indicates whether the current value of the Value property is to be serialized.

Declaration
protected bool ShouldSerializeValue()
Returns
Type
System.Boolean

ShouldSerializeValueIndicatorColorColor()

Indicates whether the current value of the ValueIndicatorColor property is to be serialized.

Declaration
protected bool ShouldSerializeValueIndicatorColorColor()
Returns
Type
System.Boolean

ShouldSerializeVisualStyle()

Indicates whether the current value of the VisualStyle property is to be serialized.

Declaration
protected bool ShouldSerializeVisualStyle()
Returns
Type
System.Boolean

Events

ThresholdValueChanged

Occurs if the value is entering or leaving defined range.

Declaration
public event EventHandler<LinearGauge.LinearThresholdValueChangedEventArgs> ThresholdValueChanged
Event Type
Type
System.EventHandler<LinearGauge.LinearThresholdValueChangedEventArgs>

ValueChanged

Occurs when the Gauge value is changed.

Declaration
public event EventHandler ValueChanged
Event Type
Type
System.EventHandler

Implements

System.IDisposable