[]
        
(Showing Draft Content)

C1.Win.C1Gauge.C1GaugeBase

C1GaugeBase Class

The base class for other Gauges.

Namespace: C1.Win.C1Gauge
Assembly: C1.Win.C1Gauge.4.8.dll
Syntax
public abstract class C1GaugeBase : Component, ICloneable, IBindableComponent, IComponent, IDisposable

Properties

Name Description
BoundValue

Gets or sets the bound data value associated with the main pointer.

Bounds

Gets the size and location of the Gauge, in pixels, relative to the parent control.

ColorMaps

Gets the collection of templates for value colors.

CommonBorders

Gets the collection of templates for the C1GaugeBorder object.

CommonFillings

Gets the collection of templates for the C1GaugeFilling object.

CommonFonts

Gets the collection of templates for text font and color.

CommonGradients

Gets the collection of templates for the C1GaugeGradient object.

CommonImages

Gets the collection of templates for the C1GaugeCustomImage object.

CommonShadows

Gets the collection of templates for the C1GaugeShadow object.

CommonShapes

Gets the collection of templates for the C1GaugeCustomShape object.

CoverShapes

Gets the collection of shapes in the top layer (over everything).

DataBindings

Gets a reference to the collection of data bindings for the Gauge.

DataField

Gets or sets the field of the data source to which the main pointer is bound.

DataSource

Gets or sets the data source object for the main pointer.

Decorators

Gets the collection of the Gauge decorators.

Enabled

Gets or sets whether the Gauge is enabled.

FaceAhead

Gets or sets whether the FaceShapes should appear in front of the other Gauges.

FaceShapes

Gets the collection of shapes in the bottom layer (between the background and the decorators).

ImageMaps

Gets the collection of templates for value images.

IsDisposed

Gets a value indicating whether the Gauge has already been disposed.

IsLogarithmic

Gets or sets if it uses a logarithmic scale. When true, uses the LogarithmicBase.

IsReversed

Gets or sets whether scale values should appear in reversed order (from Maximum to Minimum).

LogarithmicBase

Gets or sets the log base used when the IsLogarithmic is set to True.

Maximum

Maximum value for the Gauge.

Minimum

Minimum value for the Gauge.

MorePointers

Gets the collection of the other pointers, except the main pointer.

MorePointersValue_0

Gets or sets the bound data value associated with pointer #0 from the MorePointers collection.

MorePointersValue_1

Gets or sets the bound data value associated with pointer #1 from the MorePointers collection.

MorePointersValue_2

Gets or sets the bound data value associated with pointer #2 from the MorePointers collection.

MorePointersValue_3

Gets or sets the bound data value associated with pointer #3 from the MorePointers collection.

Name

Gets or sets the unique name for this C1GaugeBase.

Owner

Gets the owner control.

Pointer

Gets the main Gauge pointer.

SlidingScale

Optimizes painting for the case if the Minimum and Maximum properties are variable.

Value

Gets or sets the current value of the Gauge.

ViewTag

Gets or sets a digital tag identifying this element's views.

Viewport

Specifies the bounds of the Gauge working area.

Visible

Gets or sets whether the Gauge is visible.

Methods

Name Description
Dispose(bool)

Clean up any resources being used.

GetValueAt(int, int)

Returns the Value that corresponds to the specified mouse position: (x, y), relative to the parent control.

Load(Stream)

Loads a Gauge definition from a Stream.

Load(string)

Loads a Gauge definition from an XML file.

Load(XmlDocument)

Loads a Gauge from an XmlDocument.

LoadView(Stream)

Loads a Gauge view from a Stream.

LoadView(string)

Loads a Gauge view from an XML file.

LoadView(XmlDocument)

Loads a Gauge view from an XmlDocument.

OnFormatLabel(FormatLabelEventArgs)

Raises the FormatLabel event.

OnItemClick(ItemEventArgs)

Raises the ItemClick event.

OnItemDoubleClick(ItemEventArgs)

Raises the ItemDoubleClick event.

OnItemMouseDown(ItemMouseEventArgs)

Raises the ItemMouseDown event.

OnItemMouseEnter(ItemEventArgs)

Raises the ItemMouseEnter event.

OnItemMouseLeave(ItemEventArgs)

Raises the ItemMouseLeave event.

OnItemMouseMove(ItemMouseEventArgs)

Raises the ItemMouseMove event.

OnItemMouseUp(ItemMouseEventArgs)

Raises the ItemMouseUp event.

OnItemStateChanged(ItemEventArgs)

Raises the ItemStateChanged event.

OnMouseClick(MouseEventArgs)

Raises the MouseClick event.

OnMouseDoubleClick(MouseEventArgs)

Raises the MouseDoubleClick event.

OnPointerDragBegin(PointerDragEventArgs)

Raises the PointerDragBegin event.

OnPointerDragCancel(PointerDragEventArgs)

Raises the PointerDragCancel event.

OnPointerDragEnd(PointerDragEventArgs)

Raises the PointerDragEnd event.

OnPointerDragMove(PointerDragEventArgs)

Raises the PointerDragMove event.

OnPointerValueChanged(PointerValueChangedEventArgs)

Raises the PointerValueChanged event.

OnValueChanged(EventArgs)

Raises the ValueChanged event.

Reset()

Clears all collections and resets the properties to their default values.

Save(Stream)

Saves a Gauge definition into a Stream.

Save(Stream, Encoding)

Saves a Gauge definition into a Stream.

Save(string)

Saves a Gauge definition into an XML file.

Save(string, Encoding)

Saves a Gauge definition into an XML file.

Save(XmlWriter)

Saves a Gauge definition into an XmlWriter.

SaveView(Stream)

Saves a Gauge view into a Stream.

SaveView(Stream, Encoding)

Saves a Gauge view into a Stream.

SaveView(string)

Saves a Gauge view into an XML file.

SaveView(string, Encoding)

Saves a Gauge view into an XML file.

SaveView(XmlWriter)

Saves a Gauge view into an XmlWriter.

ShouldSerializeColorMaps()

This member is for internal use only.

ShouldSerializeCommonBorders()

This member is for internal use only.

ShouldSerializeCommonFillings()

This member is for internal use only.

ShouldSerializeCommonFonts()

This member is for internal use only.

ShouldSerializeCommonGradients()

This member is for internal use only.

ShouldSerializeCommonImages()

This member is for internal use only.

ShouldSerializeCommonShadows()

This member is for internal use only.

ShouldSerializeCommonShapes()

This member is for internal use only.

ShouldSerializeCoverShapes()

This member is for internal use only.

ShouldSerializeDecorators()

This member is for internal use only.

ShouldSerializeFaceShapes()

This member is for internal use only.

ShouldSerializeImageMaps()

This member is for internal use only.

ShouldSerializeMorePointers()

This member is for internal use only.

ShouldSerializePointer()

This member is for internal use only.

ShouldSerializeViewport()

This member is for internal use only.

ToString()

Returns a string that represents the current object.

Events

Name Description
FormatLabel

Occurs when C1GaugeLabels or C1GaugeSingleLabel converts a value to the string representation.

ItemClick

Occurs when a Gauge item is clicked.

ItemDoubleClick

Occurs when a Gauge item is double-clicked.

ItemMouseDown

Occurs when the mouse pointer is over a Gauge item and a mouse button is pressed.

ItemMouseEnter

Occurs when the mouse pointer enters a Gauge item.

ItemMouseLeave

Occurs when the mouse pointer leaves a Gauge item.

ItemMouseMove

Occurs when the mouse pointer is moved over a Gauge item.

ItemMouseUp

Occurs when the mouse pointer is over a Gauge item and a mouse button is released.

ItemStateChanged

Occurs when the state of a Gauge item is changed.

MouseClick

Occurs when the Gauge is clicked by the mouse.

MouseDoubleClick

Occurs when the Gauge is double clicked by the mouse.

PointerDragBegin

Occurs when the user starts dragging a Gauge pointer.

PointerDragCancel

Occurs if the user cancels dragging a Gauge pointer by pressing the Escape key.

PointerDragEnd

Occurs when the user ends dragging a Gauge pointer.

PointerDragMove

Occurs when a Gauge pointer is dragged with the mouse.

PointerValueChanged

Occurs when the Value property changes for some Gauge pointer.

ValueChanged

Occurs when the Value property changes for the main pointer.