Class GaugeObject
Represents a gauge object.
Inheritance
Implements
Inherited Members
Namespace: FastReport.Gauge
Assembly: FastReport.Base.dll
Syntax
public class GaugeObject : ReportComponentBase, IFRSerializableConstructors
GaugeObject()
Initializes a new instance of the GaugeObject class.
Declaration
public GaugeObject()GaugeObject(Double, Double, Double)
Initializes a new instance of the GaugeObject class.
Declaration
public GaugeObject(double minimum, double maximum, double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | minimum | Minimum value of gauge. |
| System.Double | maximum | Maximum value of gauge. |
| System.Double | value | Current value of gauge. |
GaugeObject(Double, Double, Double, GaugeScale, GaugePointer)
Initializes a new instance of the GaugeObject class.
Declaration
public GaugeObject(double minimum, double maximum, double value, GaugeScale scale, GaugePointer pointer)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | minimum | Minimum value of gauge. |
| System.Double | maximum | Maximum value of gauge. |
| System.Double | value | Current value of gauge. |
| GaugeScale | scale | Scale of gauge. |
| GaugePointer | pointer | Pointer of gauge. |
Properties
Expression
Gets or sets an expression that determines the value of gauge object.
Declaration
public string Expression { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Label
Gets or sets gauge label.
Declaration
public virtual GaugeLabel Label { get; set; }Property Value
| Type | Description |
|---|---|
| GaugeLabel |
Maximum
Gets or sets the maximal value of gauge.
Declaration
public double Maximum { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
Minimum
Gets or sets the minimal value of gauge.
Declaration
public double Minimum { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
Pointer
Gets or sets pointer of gauge.
Declaration
public GaugePointer Pointer { get; set; }Property Value
| Type | Description |
|---|---|
| GaugePointer |
Scale
Gets or sets scale of gauge.
Declaration
public GaugeScale Scale { get; set; }Property Value
| Type | Description |
|---|---|
| GaugeScale |
Value
Gets or sets the current value of gauge.
Declaration
public double Value { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
Vertical
Gets a value that specifies is gauge vertical or not.
Declaration
public bool Vertical { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
Assign(Base)
Copies the contents of another, similar object.
Declaration
public override void Assign(Base source)Parameters
| Type | Name | Description |
|---|---|---|
| Base | source | Source object to copy the contents from. |
Overrides
Remarks
Call Assign to copy the properties from another object of the same type. The standard form of a call to Assign is
destination.Assign(source);
which tells the destination object to copy the contents of the source object to itself. In this method, all child objects are ignored. If you want to copy child objects, use the AssignAll method.
See Also
Clone()
Clone Gauge Object
Declaration
public GaugeObject Clone()Returns
| Type | Description |
|---|---|
| GaugeObject | clone of this object |
Draw(FRPaintEventArgs)
Draws the gauge.
Declaration
public override void Draw(FRPaintEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| FRPaintEventArgs | e | Draw event arguments. |
Overrides
GetData()
Gets the data from a datasource that the object is connected to.
Declaration
public override void GetData()Overrides
Remarks
This method is called by the report engine before processing the object.
Do not call it directly. You may override it if you are developing a new FastReport component. In this method you should get the data from a datasource that the object is connected to.
GetDataAsync(CancellationToken)
Declaration
public override async Task GetDataAsync(CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
Overrides
GetExpressions()
Gets all expressions contained in the object.
Declaration
public override string[] GetExpressions()Returns
| Type | Description |
|---|---|
| System.String[] | Array of expressions or null if object contains no expressions. |
Overrides
Remarks
Do not call this method directly. You may override it if you are developing a new component for FastReport.
This method is called by FastReport each time before run a report. FastReport do this to collect all expressions and compile them. For example, GetExpressions method of the TextObject class parses the text and returns all expressions found in the text.
Serialize(FRWriter)
Serializes the object.
Declaration
public override void Serialize(FRWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| FRWriter | writer | Writer object. |
Overrides
Remarks
Do not call this method directly. You should override it if you are developing a new component for FastReport.
This method is called when the object needs to save the state. It may happen when:
- saving the report to the file or stream;
- saving the report to the designer's undo buffer;
- assigning the object to another object using the Assign(Base) or AssignAll methods;
- saving the object to the designer's clipboard;
- saving the object to the preview (when run a report).