Edit Field Control

An edit field control is designed to gather textual input from the user such as a company name, file path or telephone number. An example of an edit field can be seen below:

 

Additional features of the edit field control can be found in the following two categories:

 

Notification Messages

A notification message is triggered whenever the user interacts with a control, or whenever user interaction affects a control in some way. Each notification message consists of a number that identifies the type of interaction that has occurred, and a table containing details specific to that type of interaction. These two values are passed to the screen's On Ctrl Message event as the event variables e_MsgID and e_Details.

Note: Notification messages are triggered when actions interact with this control.

(number) e_MsgID
A numeric constant that represents the specific notification message that was fired by the screen control. See the e_MsgID column below for all possible message ids that can be fired by an edit field control.

(table) e_Details
A table of additional details that may be passed by the control when certain notification messages are fired. See the e_Details column below for the kinds of details that are returned and the table indexes that you can use to access them. For example, you can access the item "Text" from this table by using e_Details.Text.

e_MsgID

e_Details

Description

MSGID_ONCHANGED

(string) Text - The new text of the control

Fired when the edit field's text changes.

 

Related Actions

The following actions are available for interacting with an edit field control:

 

DlgEditField.GetProperties

DlgEditField.SetProperties