DlgEditField.GetProperties

table DlgEditField.GetProperties ( 

number ControlID )

Description

Gets the properties of an edit field control on the current screen.

Note: This action will only work if called from a screen's events and if the named control is on the current screen.

Parameters

ControlID

(number) The numeric ID of the edit field control whose properties you want.

Returns

(table) A table containing the control properties, indexed by the following categories:

KEY

TYPE

DESCRIPTION

Enabled

boolean

Whether or not the control is enabled. If true is returned the control is enabled. A false result means it is disabled. You can access this value using tb.Enabled.

Text

string

The text currently displayed in the control. It can be accessed using tb.Text.

Visible

boolean

Whether or not the control is visible. If true is returned the control is visible. A false result means it is not visible. You can access this value using tb.Visible.

Multiline

boolean

Whether or not the control supports multiple lines of text. If true is returned, multiline text is enabled. A false result means it is disabled. You can access this value using tb.Multiline. This option only has an effect if the control is on a custom screen.

If the current screen does not contain the control, this action will fail. If this action fails, nil is returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the action editor, you can use this field to specify a variable that the return value will be stored in.

See also:  Related Actions