AddressEntry

(Dialog Library)

Description: Checks whether the attached driver has an AddressAssist module and uses that if available. Otherwise, presents a standard edit field into which the I/O address may be entered.
Returns: Nothing
Usage: Steady State only.
Function Groups: Graphics
Related to: GUITransform | PAddressEntry | PAreaSelect | PCheckBox | PContributor | PDroplist | PEditField | PPageSelect | PRadioButtons | PSecBit | PSelectObject | PSpinbox | PTypeToggle
Format: \DialogLibrary.AddressEntry(X1, Y1, X2, Y2, Var,  IODevice, SupportedData,  FunctionType,  Title,  FocusID[, Trigger, Visible, DrawBevel, BGColor, FGColor])
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.
Var
Variable to be set by AddressEntry
IODevice
Any expression for the name of the I/O device driver being used.
SupportedData

A bitwise expression, indicating the data type.

(See: Bitwise Parameters & Operations)

Bit

Meaning when set

0

Digital

1

Analog

2

Text

FunctionType
Any Boolean expression, indicating whether the function should be read (0) or write (1).
Title
Any text expression to use as the title for the field.
FocusID
Any numeric expression from 0 to 32767 for the focus number of this graphic. If this value is 0, the field will display its current setting, but will not be able to be opened (i.e. its value cannot be changed), and will appear disabled (grayed-out).
Trigger
A parameter whose value is derived from ZEditField and can therefore be set to "0" (internal buffer changed), "1" ("Enter" key pressed), or "2" (focus lost). If this information is not required and the next parameter is used, a value of invalid or a constant may be substituted.
Visible
Boolean. Controls the visibility of the control.
DrawBevel
Any logical expression. If TRUE, a bevel is drawn around the graphic.
BGColor
Optional. Any numeric expression for the background VTScada Color Palette of the control. No default value.
FGColor
Placeholder for the foreground color of the control. Not currently implemented.
Comments: Similar to PAddressEntry.

Example:

  {***** History Address *****}
  AddressEntry(30, 200, WIDTH/2 - 5, 155,
               HistoryAddr                        { Variable to set         },
               Scope(\Root, Parms[\#SitePoint])   { IO Device               },
               0b001                              { SupportedData: Digital  },
               0                                  { FunctionType:  Read     },
               GetPhrase("HistoryAddressLabel")   { Title                   },
               EditOK ? 5 : 0                     { Focus ID                },
               Trigger1                           { trigger                 },
               UsingHist                          { Visible                 },
               Invalid                            { Bevel                   },
               HighlightColor1                    { BG Colour               });