GaugeGetSubCaptionFormat method (WinStudio scripts)

Applies To

IWSFormComponent interface

Definition

Gets the Sub-Caption Format for a Critical Number-bound gauge.

Syntax

object.GaugeGetSubCaptionFormat

Remarks

The return value is a string containing the format of the sub-caption on the critical number gauge. Valid values are:

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

Example

Sub Main()
    Application.ShowMessage(ThisForm.Components("gauge1").GaugeGetSubCaptionFormat)
End Sub