PContributor

VTS Functions > P Functions

PContributor

(VTS Library)

Description: This module draws a splitlist displaying all contributors to a specific tag.

Returns: Nothing

Usage: Steady State

Format: \DialogLibrary\PContributor(HolderName, ContainerObj, ContribType, TagType [, Title, FocusID])

Parameters: HolderName { text } { required } { no default }

Any text expression giving the variable name for container information.

ContainerObj { Object value } { required } { no default }

The object value of the container.

ContribType { text } { required } { no default }

Any text expression giving the contribution type.

TagType { text } { required } { no default }

Any text expression for the type of Tag for which the contributors are being sought.

Title { text } { optional } {no default }

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

FocusID { numeric } { optional } { default: see note }

An optional parameter that is any numeric expression for the focus number of the splitlist and its two buttons. The splitlist will have a focus ID equal to FocusID, the left button will have one of FocusID + 1, while the right button will have a focus ID of FocusID + 2. If FocusID is 0, the splitlist will display its current setting, but its accompanying buttons will not be able to be selected.

If this parameter is omitted or invalid, the next available focus ID will be assigned.

Comments: This module is a member of the VTS Dialog Library and must therefore be called from within a GUITransform and prefaced by \DialogLibrary\.

The "P" tools (PCheckbox, 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. It will then set the element indicated by ParmNum to the chosen tag's name.

For any optional parameter that is to be set, all optional parameters preceding the desired one must be present, although they may be invalid.

This function provides a split list containing the names and descriptions of all contributors stored in HolderName. Double-click on an item in this list to obtain the Properties dialog for the tag. Click on the Add button to add a new contributor of the tag type "PointType", which is owned by "ContainerObj", and which has a contribution type "ContribType". Click on the Delete button to terminate the container/contributor relationship for the currently highlighted contributor. The former contributor is not deleted from the application, or from the database.

Examples:

GUITransform(10, 410, 310, 10,

1, 1, 1, 1, 1,

0, 0, 1, 0,

0, 0, 0,

\DialogLibrary\PContributor(

"" { Holder name },

Var { Container object },

"" { Contributor type },

"AnalogInput" { Tag type },

"Contributors" { Title },

4 { Focus ID }));