SplitTagSelector
(VTScada-Layer function. Must be called with a leading backslash.)
Description: | Draws a split view comprising two GridLists separated by control buttons. Tag names listed on the left may be selected to be transferred to the right. Each GridList will have two columns: the name and the description of each tag in the list. Scrollbars will be drawn if required. |
Returns: | Nothing |
Usage: | Steady State only. |
Function Groups: | Graphics |
Related to: | SplitListSelector | GridList |
Format: | \SplitTagSelector(InitTagArray, DestTagArray[, LeftLabel, RightLabel, DestMax, EnableParm]) |
Parameters: |
InitTagArray |
Required. An array of tag names passed in to form the initial list on the left. |
DestTagArray |
Required. Array of destination tag names. Can be an array of tags passed in to form the initial list on the right. |
LeftLabel |
Optional label for the left list. |
RightLabel |
Optional label for the right list. |
DestMax |
Maximum number of destination tag names. The default is invalid which is taken to mean unlimited. |
EnableParm |
Flag to enable the controls. |
Comments: | A tool intended to provide a user interface for selecting tags from a list on the left and transferring them to the right. Both GridLists have two columns, the name and the description of the tags. The InitTagArray is an array of Tag names. The DestTagArray is an array of selected Tag names. The Tag names are used as keys for comparison purposes. The tags on the left will be updated if the InitTagArray changes. When tags are moved from the right to the left, they are inserted in the left only if they exist in the InitTagArray. If not, they are simply removed from the DestTagArray. The SplitTagSelector should be called from within a GUITransform as shown in the following example. |
Examples:
GUITransform(30, 270, 470, 90, 1, 1, 1, 1, 1 { Scaling }, 0, 0 { Movement }, 1, 0 { Visibility, scaling }, 0, 0, 0 { Selectability }, \SplitTagSelector(InitResourceList, SelectedResources, \GetPhrase("AvailableResourcesLabel"), \GetPhrase("SelectedResourcesLabel")));