GaugeGetProperty method (WinStudio scripts)

Applies To

IWSFormComponent interface

Definition

Returns the value of a gauge component property as specified in the GaugeProperty enumeration.

Syntax

T GaugeGetProperty<T>( GaugeProperty.propertyName )

  Part     Description    
 T Required. Indicates the datatype of the property value being returned (string, int, float, etc.).
<T> Required. Indicates a generic datatype parameter.
propertyName Required. Specifies the name of the gauge property for which you want to retrieve the value.

Remarks

The GaugeProperty enumeration contains a value for each available gauge property.

Examples

For C#:

IWSFormComponent gauge = ThisForm.Components("gauge1");
string caption = gauge.GaugeGetProperty<string>(GaugeProperty.Caption);
gauge.GaugeSetProperty(GaugeProperty.Caption, "Total");

For VB:

Dim gauge As IWSFormComponent = ThisForm.Components("gauge1")
Dim caption As String = gauge.GaugeGetProperty(Of String)(GaugeProperty.Caption)
gauge.GaugeSetProperty(GaugeProperty.Caption, "Total");