PPageSelect

(Dialog Library)

Description:	Draws a titled, beveled droplist of pages in the system.
Returns:	Nothing
Usage:	Steady State only.
Function Groups:	Graphics
Related to:	GUITransform \| PAddressEntry \| PAlmPriority \| PAreaSelect \| PCheckBox \| PColorEdit \| PFileChooser \| PColorSelect \| PContributor \| PDroplist \| PEditField \| PEditName \| PHSliderBar \| PHueSelect \| PImageSelect \| PIPAddressList \| PIPListenerGroup \| PMultiCheckBox \| PPhraseEdit \| PRadioButtons \| PSecBit \| PSelectObject \| PServerListName \| PSpinbox \| PTimeZone \| PTypeToggle \| SiteDispParms
Format:	\DialogLibrary.PPageSelect(ParmNum [, Title, FocusID, VertAlign, AlignTitle, DrawBevel, ShowTitles, UnspecifiedLabel, FilterContext, ShowSubordinates])
Parameters:

ParmNum

Required. Any numeric expression giving the parameter number (from 0) in the caller to alter.

Title

An optional parameter that is any text expression to be used as a title for the droplist.

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).

VertAlign

An optional parameter that is any numeric expression that sets the vertical alignment of the droplist according to one of the following options:

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.

AlignTitle

An optional parameter that is any logical expression. If 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 has been vertically aligned. The default is true.

DrawBevel

Optional Boolean. Set to TRUE if a bevel is to be drawn. Defaults to TRUE.

ShowTitles

Optional Boolean. Set to TRUE to show page titles. Defaults to FALSE.

UnspecifiedLabel

Optional text. A label to display when no page is selected.

FilterContext

Reserved.

ShowSubordinates

Optional BOOLEAN. TRUE to show pages from subordinate apps. Defaults to FALSE.

Note that tags in a master application should never be configured to use site pages from a subordinate application.

Comments:

This module is a member of the VTScada Dialog Library and must therefore be called from within a GUITransform and prefaced by \DialogLibrary..
This parameter tool expects the first parameter of its calling module to contain an array of tag parameters. It will then set the element indicated by ParmNum to the name of the chosen page.
The height of the (unopened) droplist is constant, with the horizontal boundaries of its calling transform defining its width, and the vertical boundaries of its calling transform defining its opened height, which will include the added height of the bevel above the field, but may or may not include the title, depending on the alignment used. Note that if the entire list can be displayed in a smaller area than indicated by the vertical boundaries of the calling transform, the dropped list height will be decreased. The dropped height of the list will always have a minimum height of 1 line (below the field).
For any optional parameter that is to be set, all optional parameters preceding the desired one must be present, although they may be invalid.

Usual height: 45 pixels.

Examples:

GUITransform(10, 125, 210, 25,
             1, 1, 1, 1, 1,
             0, 0, 1, 0,
             0, 0, 0,
             \DialogLibrary.PPageSelect(2                 { Parm num          },
                                        \GetPhrase("SelectPageLabel") { Title },
                                        TRUE              { Focus ID          },
                                        Invalid           { Default alignment },
                                        1                 { Align title       }));

Notice in the above example that the last two parameters could have been omitted, because they are optional and their settings match those used as a default.