PTimeZone

(Dialog Library)

Description:

Tool used to display a list of timezones, as defined by the operating system.

Returns: Nothing
Usage: Steady State only.
Function Groups: Graphics
Related to: GUITransform | PAddressEntry | PAlmPriority | PAreaSelect | PCheckBox | PColorEdit | PColorSelect | PContributor | PDroplist | PEditField | PEditName | PFileChooser | PHSliderBar | PHueSelect | PImageSelect | PIPAddressList | PIPListenerGroup | PMultiCheckBox | PPageSelect | PPhraseEdit | PRadioButtons | PSecBit | PSelectObject | PServerListName | PSpinbox | PTypeToggle | SiteDispParms
Format: \DialogLibrary.PTimeZone(ParmNum,Title, AlignTitle[, FocusID, Trigger, InitVal, DrawBevel, VertAlign])
Parameters:  
ParmNum
Required. Any numeric expression giving the parameter number (from 0) in the caller to alter.
Title
Text to be displayed above the parameter.
AlignTitle
Boolean controlling the text alignment. If this parameter is invalid or numeric, it indicates the title alignment such that if it is true (non-0) the title is included in the calculation for vertical alignment, if false(0) it is added to the droplist after it (and its bevel if one exists) has been vertically aligned. The default is true
FocusID
Boolean. If this value is FALSE (0), the field will display its current setting, but cannot be opened (i.e. its value cannot be changed), and will appear disabled (grayed-out).
Trigger
Optional. If the list is editable, Trigger provides feedback. While editing, the value will be 0. When editing is complete (tab, enter or loss of focus) the value will change to non-zero: 1 if enter is pressed, 2 otherwise.
InitVal
An optional parameter that is any expression for the initial value displayed in the field.
DrawBevel
Optional Boolean expression that when set to TRUE, causes a bevel to be drawn around the control. Defaults to FALSE.
VertAlign
An optional parameter that is any numeric expression that sets the vertical alignment of the unopened list according to one of the following:

VertAlign

Vertical Alignment

0

Top

1

Center

2

Bottom

Whether the title is included when the vertical alignment is calculated is determined by the value of AlignTitle. The default value is 0.

Comments:

Value will be set to one of:

  • Invalid = UTC selected
  • 0 = Local timezone selected
  • Text = Name of timezone selected

The set value can be plugged directly into calls to ConvertTimestamp()


This module is a member of the VTScada Dialog Library and must therefore be called from within a GUITransform and prefaced by \DialogLibrary\.
The "P" tools (Pcheck box, PContributor, PColorSelect, PDroplist, and PEditField) were intended only for use in configuration folders and drawing panel modules, and therefore are subject to the system security restraints.

This parameter tool expects the first parameter of its calling module to contain an array of tag parameters.

Usual height: 155 pixels.

GUITransform(30, 45 + 4*Space + TitleSpace + 3*CheckHt + TEditHt + TDropHt,
             WIDTH-30, 45 + 4*Space + TitleSpace + 3*CheckHt + TEditHt,
             1, 1, 1, 1, 1,
             0, 0, 1, 0,
             0, 0, 0,
             \DialogLibrary.PTimeZone(\#DeviceTimezone         { Parm num   }, 
                                      \GetPhrase("Your_Title") { Title      },
                                      TRUE                     { AlignTitle }, 
                                      TRUE                     { FocusID    }, 
                                      Trigger, 
                                      Invalid                  { InitVal    },
                                      FALSE                    { DrawBevel  }, 
                                      0                        { VertAlign  }));