IPAddressList

(VTScada-Layer function. Must be called with a leading backslash.)

Description:	Displays a list of IP address which can be added to or removed from.
Returns:	Text
Usage:	Steady State only.
Function Groups:	Graphics,  String and Buffer
Related to:	PIPAddressList
Format:	\IPAddressList(X1, Y1, X2, Y2, AddressList, BaseFocusID[, Title, DrawBevel, AlignTitle, ListBGndColor, OverlayCallback]);
Parameters:

X1

Required. Any numeric expression giving the X coordinate on the screen of one side of the object and its label. The smaller of X1 and X2 will always be to the left

Y1

Required. Any numeric expression giving the Y coordinate on the screen of either the top or bottom of the object. The smaller of Y1 and Y2 will always be the top.

X2

Required. Any numeric expression giving the X coordinate on the screen of the side of the object and its label opposite to X1.

Y2

Required. Any numeric expression giving the Y coordinate on the screen of the top or bottom of the object, whichever is the opposite to Y1.

AddressList

Required. The array of IP addresses to display / the array of IP addresses returned.

BaseFocusID

Required. Reserves 10 focus ID values beginning at the value provided. Set to zero to disable user input.

Title

Optional. Any text expression to use as the title for the field. No default value

DrawBevel

Optional. Any logical expression. If TRUE, a bevel is drawn around the graphic. Defaults to FALSE.

AlignTitle

Optional. Any logical value. If TRUE then title affects alignment

ListBGndColor

Optional. Any numeric expression setting a background color for the list. No default value.

OverlayCallback

Optional module value. Called from the listbox. No default value.

Comments:

Control is read-only if BaseFID is zero. Addresses are validated by a utility function in SocketServerManager before being added to the list. Controls are available for removing items and reordering. A double-click on a list item will copy it into the edit field. The resulting list is stored in the AddressList array, which also serves as the initial display on initialization. Note that addresses are only validated when the add button is pressed.

Example:

The following example is taken from the PIPAddressList code. The overlay callback allows the caller to react to user actions such as right-clicks.

  \IPAddressList(LHS, BTM, RHS, TOP, AddressArray, 
                 AllowEdit ? ID : 0, 
                 Title, DrawBevel, AlignTitle, HighlightColor, 
                 Variable("OverlayCallback") { List overlay graphics callback });