Input Object

Here are the object's settings as they appear in the properties inspector:

Input Object

Name

The name that is used to identify this object.

Type

The type of input box you want to use. Choose from:

Single Line

Enable a single line of input text.

Multi Line

Enable multiple lines of input text.

Text

The text that you want to display in the input object.

Font

The font that you want to use for the text. Click the edit button ( ) to open the Font dialog where you can edit all of the font settings.

Family

The font family that you want to use.

Size

The font size, in points.

Bold

Make the text bolded.

Italic

Make the text appear in italics.

Alignment

The alignment to use. Choose from:

Left

Left-align the text within the input object, like so:

This text is left-aligned

Center

Center the text within the input object, like so:

This text is centered

Right

Right-align the text within the input object, like so:

This text is right-aligned

Text Color

The color to display user input text.

Tip: You can click the select button ( ) to bring up a color chooser.

Back Color

The background color to use for the object.

Style

The display style of the text in the input object. Choose from:

Standard

Display the input text normally.

Password

Hide any text that the user types by displaying asterisks (****).

Note: The password feature is not available for the Multi Line style.

Input Mask

Control the text the user inputs into the object.

Input Mask

The input mask you want to use to control the data the user inputs into the object. Input masks let you pre-format the user's response a bit with "guide" characters, and help prevent errors by performing keystroke validation. You can click the select button ( ) to display a list of sample input masks.

One of the sample input masks available is a telephone number. It appears in the list as (###) ###-####.
The "#" character in the input mask is a special digit placeholder (0-9). For every # in the input mask, the user will only be able to enter a digit between 0 and 9. At runtime, the user will only be able to enter 10 numeric characters and will appear as a formatted telephone number such as (204) 946-0263.

You can also include alphabetic characters in an input mask. For example, one of the sample input masks is ?#? #?# used to represent a Canadian postal code. The "?" character in the input mask is a special alphabetic placeholder (a-Z). For every ? in the input mask, the user will only be able to enter a letter from a to z. For example, R3B 0R3 is one valid postal code that the user could enter. The mask would prevent the user from entering two sequential alphabetic characters or numbers.

Placeholder

Text used as a placeholder for the input mask. This can be used as sample input until the user fills the input mask. For the telephone number input mask mentioned in the above example, you could include a sample digit as the placeholder such as 9. At runtime it would appear as (999) 999-9999 until the user replaced these digits with their own.

Return

The input text to return. Choose from:

Formatted

Return only the text the user typed. This does not include any Input Mask characters.

As Typed

Return all text displayed in the input object. This includes any text displayed by the Input Mask.

V. Scroll

Include a vertical scroll bar for the object. Choose from:

True

Include a vertical scroll bar.

False

Don't include a vertical scroll bar.

H. Scroll

Include a horizontal scroll bar for the object. Choose from:

True

Include a horizontal scroll bar.

False

Don't include a horizontal scroll bar.

Border

The border style to display around the input object. Choose from:

None

Don't display any border around the object.

Flat

Display a thin black border around the object.

Sunken

The object will have a "sunken" appearance on the page.

Read Order

The order the text will display when typed into the object. Choose from:

Standard

Display the text normally, from left to right.

Right to Left

If the shell language is Hebrew, Arabic, or another language that supports reading-order alignment, the text is displayed using right-to-left reading-order properties. For other languages, this style is ignored.

Read Only

Make the text in the object read-only so the user cannot type into it. Choose from:

True

Any text displayed in the object will be read-only. This means the user can copy the text, but cannot modify it.

False

Any text displayed in the object can be modified.

Attributes

Tooltip

A short string of text that will appear after the mouse hovers over this object for a moment.

Enabled

Enable the object so it responds to user interaction. Choose from:

True

The object will respond to mouse overs and clicks and perform any actions assigned to its events.

False

The object will not respond to any mouse overs or clicks and will not perform any actions until it is enabled.

Note: You can use the Input.SetEnabled action to enable this object.

Visible

Set the object's initial visibility. Choose from:

True

The object will be visible when the page is displayed.

False

The object will be invisible when the page is displayed.

Note: You can use the Input.SetVisible action to make the object visible or invisible at run time.

Left

The distance in pixels from the left edge of the object to the left edge of the page.

Tip: You can also change the position of an object by dragging it.

Top

The distance in pixels from the top edge of the object to the top edge of the page.

Width

The width of the object in pixels.

Tip: You can also resize an object by dragging one of the resize handles on its bounding box.

Height

The height of the object in pixels.

Actions

On Key

The actions that will be performed whenever the cursor is inside the input object and the user presses a key. Click the edit button ( ) to open the action editor.

The following event variables are automatically set whenever this event is triggered:

e_Key

(number) The virtual key code of the key that was pressed.

e_Modifiers

(table) A table containing three boolean values that describe which modifier keys were held down while the key was pressed. A modifier key is a key that can be held down while another key is pressed, to "modify" it.

There are three true/false values in the table, one for each type of modifier key on the keyboard: shift, ctrl, and alt. You can access these values as e_Modifiers.shift, e_Modifiers.ctrl, and e_Modifiers.alt.

On Focus

The actions that will be performed whenever the input object is given focus. For example, it will be given focus if the user clicks inside the object. Click the edit button ( ) to open the action editor.