GaugeSetSubCaptionFormat method (WinStudio scripts)

Applies To

IWSFormComponent interface

Definition

Sets the Sub-Caption Format (All, Actual, None) for a Critical Number-bound gauge.

Syntax

object.GaugeSetSubCaptionFormat(string)

Part Description
object Required. A reference to a valid gauge component object.
string Required. A string setting the sub-caption format of the gauge.

Remarks

Valid sub-caption formats are:

  • All: Show goal, alert, and actual values
  • Actual: Show actual value
  • None: Sub-caption can be manually set on the critical number gauge

Example

Sub Main()
    ThisForm.Components("gauge1").GaugeSetSubCaptionFormat("Actual")
End Sub