Class RadLinearGauge

Represents a linear gauge control for displaying a value within a defined range using various visual indicators such as bars, ticks, labels, and needles.

Inheritance
System.Object
RadControl
RadLinearGauge
RadBulletGraph
Inherited Members
Namespace: Telerik.WinControls.UI.Gauges
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadLinearGauge : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadLinearGauge()

Initializes a new instance of the RadLinearGauge class.

Declaration
public RadLinearGauge()

Properties

DefaultSize

Gets the default size of the control based on its orientation.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

ForeColor

Gets or sets the foreground color of the control, which is applied to the root element.

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

Overrides

GaugeElement

Gets the RadLinearGaugeElement that represents the main gauge element containing all visual components.

Declaration
public RadLinearGaugeElement GaugeElement { get; }
Property Value
RadLinearGaugeElement

Items

Gets the collection of gauge items (bars, ticks, labels, needles, etc.) that comprise the gauge's visual elements.

Declaration
[RadEditItemsAction]
public virtual RadItemOwnerCollection Items { get; }
Property Value
RadItemOwnerCollection

RadLinearGaugeName

Gets the type name of the RadLinearGauge for serialization purposes.

Declaration
protected virtual string RadLinearGaugeName { get; }
Property Value
System.String

RangeEnd

Gets or sets the maximum value of the gauge range.

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

RangeStart

Gets or sets the minimum value of the gauge range.

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

Value

Gets or sets the current value displayed on the gauge within the specified range.

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

Vertical

This property is not relevant for this class.

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

XmlSerializationInfo

Gets or sets the serialization information for the RadLinearGauge used by Save/Load layout methods to persist gauge settings to/from XML. By default, or when set to null, the ComponentXmlSerializationInfo provided by GetDefaultXmlSerializationInfo() will be used.

Declaration
public virtual ComponentXmlSerializationInfo XmlSerializationInfo { get; set; }
Property Value
ComponentXmlSerializationInfo

Methods

CreateChildItems(RadElement)

Creates the child elements for the control, specifically the main RadLinearGaugeElement.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent element that will contain the child items.
Overrides

GetDefaultXmlSerializationInfo()

Gets the default XML serialization information for the RadLinearGauge control.

Declaration
public virtual ComponentXmlSerializationInfo GetDefaultXmlSerializationInfo()
Returns
ComponentXmlSerializationInfo

The default ComponentXmlSerializationInfo for this control.

GetRootElementDesiredSize(Int32, Int32, Int32, Int32)

Gets the desired size of the root element after applying DPI scaling factors.

Declaration
protected override Size GetRootElementDesiredSize(int x, int y, int width, int height)
Parameters
System.Int32 x

The x-coordinate of the element.
System.Int32 y

The y-coordinate of the element.
System.Int32 width

The width of the element.
System.Int32 height

The height of the element.
Returns
System.Drawing.Size

The desired size of the root element.
Overrides

LoadLayout(String)

Loads RadLinearGauge properties, sub-objects and their properties from an XML file, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void LoadLayout(string fileName)
Parameters
System.String fileName

The file name to load the XML layout from.

LoadLayout(String, DesignTimeInstanceFactory)

Loads RadLinearGauge properties, sub-objects and their properties from an XML file, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void LoadLayout(string fileName, DesignTimeInstanceFactory factory)
Parameters
System.String fileName

The file name to load the XML layout from.
DesignTimeInstanceFactory factory

The DesignTimeInstanceFactory to use for creating objects during deserialization.

LoadLayout(XmlReader)

Loads RadLinearGauge properties, sub-objects and their properties from an XML reader, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void LoadLayout(XmlReader xmlReader)
Parameters
System.Xml.XmlReader xmlReader

The System.Xml.XmlReader containing the layout data to load.

LoadLayout(XmlReader, InstanceFactory)

Loads RadLinearGauge properties, sub-objects and their properties from an XML reader with the specified instance factory.

Declaration
public virtual void LoadLayout(XmlReader xmlReader, InstanceFactory factory)
Parameters
System.Xml.XmlReader xmlReader

The System.Xml.XmlReader containing the layout data.
InstanceFactory factory

The InstanceFactory to use for creating objects during deserialization.

ResetFields()

Resets the gauge properties to their default values.

Declaration
protected virtual void ResetFields()

SaveLayout(Stream)

Stores RadLinearGauge properties, sub-objects and their properties to a stream in XML format, using the serialization information provided by the XmlSerializationInfo property. The XML content is written to the stream and the stream is left open.

Declaration
public virtual void SaveLayout(Stream stream)
Parameters
System.IO.Stream stream

The stream to write the XML content to.

SaveLayout(String)

Stores RadLinearGauge properties, sub-objects and their properties to a file in XML format, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void SaveLayout(string fileName)
Parameters
System.String fileName

The file name to save the XML layout to.

SaveLayout(XmlWriter)

Stores RadLinearGauge properties, sub-objects and their properties in XML format, using the serialization information provided by the XmlSerializationInfo property.

Declaration
public virtual void SaveLayout(XmlWriter xmlWriter)
Parameters
System.Xml.XmlWriter xmlWriter

The System.Xml.XmlWriter to use for the built-in serializer.

ScaleControl(SizeF, BoundsSpecified)

Scales the control based on the specified scaling factors for DPI scaling support.

Declaration
protected override void ScaleControl(SizeF factor, BoundsSpecified specified)
Parameters
System.Drawing.SizeF factor

The scaling factor to apply to the control.
System.Windows.Forms.BoundsSpecified specified

The bounds to scale.
Overrides

Events

OrientationChanged

Occurs when the orientation of the gauge is changed between horizontal and vertical.

Declaration
public event EventHandler OrientationChanged
Event Type
System.EventHandler

ValueChanged

Occurs when the gauge value is modified.

Declaration
public event EventHandler ValueChanged
Event Type
System.EventHandler

Extension Methods