GaugeGetCaptionFormat method (WinStudio scripts)

Applies To

IWSFormComponent interface

Definition

Gets the Caption Format for a Critical Number bound Gauge.

Syntax

object.GaugeGetCaptionFormat()

Part Description
object Required. A reference to a valid gauge component object.

Remarks

The return value is a string containing the caption format setting.  Valid values are:

  • “Long:” The description from the Critical Numbers Setup form is used
  • “Short:” The short description from the Critical Numbers Setup form is used
  • “Default:” Either the long or short description is used based on the gauge type
  • “None:” The caption can be manually set on the gauge

Example

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