SiteDispParms

 

Description:

Parameter setting tool for Site List display options.

While not part of the dialog library, and not starting with the letter "p", this is still classified as one of the PTools.

Example shows parameters for a site. This function works equally for a connector.

Returns: Nothing
Usage: Steady State only.
Function Groups: Graphics
Related to: GUITransform | PAddressEntry | PAlmPriority | PAreaSelect | PCheckBox | PColorEdit | PColorSelect | PContributor | PDroplist | PEditField | PEditName | PHSliderBar | PHueSelect | PImageSelect | PIPAddressList | PIPListenerGroup | PMultiCheckBox | PPageSelect | PPhraseEdit | PRadioButtons | PSecBit | PSelectObject | PServerListName | PSpinbox | PTimeZone | PTypeToggle
Format: \SiteDispParms(Parms, SiteDispIdxs, SiteListOptions, Trigger, Reserved, ParmsData, OldParms, OldParmsData, ParmsReady)
Parameters:  
Parms
Required. A pointer to the array of parameters.
SiteDispIdxs

Required. DispParmsStruct of site parameter indices.

Invalid entries in this structure are assumed to be missing parameters. The corresponding control will be grayed out. This parameter is typically created as follows in your module initialization state.

SiteDispIdxs = \DispParmsStruct();
SiteDispIdxs\Latitude           = \#Latitude;
SiteDispIdxs\Longitude          = \#Longitude;
SiteDispIdxs\CustomDetailsPage  = \#CustomDetailsPage;
SiteDispIdxs\CustomMapIcon      = \#CustomMapIconParm;
SiteDispIdxs\SiteListDisplay    = \#SiteListDisplay;
SiteDispIdxs\InitZoom           = \#InitZoom;
SiteListOptions

Required. A bitwise value controlling which Site List display options will be shown in the radio control.

Bit 0 Automatic
Bit 1 Site
Bit 2 Folder
Bit 3 Exclude
Bit 4 Flat Folder

(See: Bitwise Parameters & Operations)

Trigger
Required Boolean. A trigger to indicate ongoing editing.
Reserved
Required but unused. Set to Invalid.
ParmsData
Required. An array of parameter data. One of the parameters to your configuration folder module.
OldParms
Required. An array of old parameters. One of the parameters to your configuration folder module.
OldParmsData
Required. An array of old parameter data. One of the parameters to your configuration folder module.
ParmsReady
Required. An array of "Ready" flags. One of the parameters to your configuration folder module.
Comments:

 

Examples:

GUITransform(30, 45 + SiteDispParmsHt, Width, 45,
             1, 1, 1, 1, 1, 0, 0, 1, 0, 0, 0, 0,
             \SiteDispParms(Parms, SiteDispIdxs, 0b11111, Trigger, Invalid,
                            ParmsData, OldParms, OldParmsData, ParmsReady));