GaugeSetCaptionFormat method (WinStudio scripts)
Applies To
IWSFormComponent interface
Definition
Sets the Caption Format (None, Short, Long, Default) for a critical number bound gauge.
Syntax
object.GaugeSetCaptionFormat(string)
| Part | Description |
|---|---|
| object | Required. A reference to a valid gauge component object. |
| string | Required. A string that represents the new format for the gauge caption. |
Remarks
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 set manually on the gauge
Example
Sub Main()
ThisForm.Components("gauge1").GaugeSetCaptionFormat("Default")
End Sub