• UI_GET_CHECK Function
• UI_GET_CHECK2 Function
• UI_GET_CHECK2P Function
• UI_GET_DATE Function
• UI_GET_DATE_CALENDAR Function
• UI_GET_EMAIL_TEMPLATES Function
• UI_GET_EXPRESSION Function
• UI_GET_FIELDNAME Function
• UI_GET_FILE Function
• UI_GET_FILES_MULTIPLE Function
• UI_GET_FILTER Function
• UI_GET_FONT Function
• UI_GET_FONTNAME Function
• UI_GET_IMAGE_FILENAME Function
• UI_GET_KEY Function
• UI_GET_LAYOUT_NAME Function
• UI_GET_LIST Function
• UI_GET_LIST2 Function
• ui_get_list2p Function
• UI_GET_LIST3 Function
• UI_GET_LIST3P Function
• UI_GET_LIST_ARRAY Function
• UI_GET_NUMBER Function
• UI_GET_NUMBER_CALCULATOR Function
• ui_get_object_name Function
• UI_GET_OPERATION Function
• UI_GET_ORDER Function
• UI_GET_PARAMETERS Function
• UI_GET_PARAMETERS_LOCAL Function
• UI_GET_PASSWORD Function
• UI_GET_PRINT_OR_PREVIEW Function
• UI_GET_PROPERTY_NAME Function
• UI_GET_QUERY_NAME Function
• UI_GET_RADIO Function
• UI_GET_RADIO2 Function
• UI_GET_RANGE Function
• UI_get_short_time Function
• UI_GET_TABLE Function
• UI_GET_TEXT Function
• ui_get_text2 Function
• UI_Get_Time Function

UI_GET_TEXT Function

Syntax

Arguments

title

The title of the dialog box.

prompt

The descriptive text next to the text field.

default_choice

Optional. Default = "". A default value to display in the text field.

format_string

Optional. Default = "" (all characters). Forces the entered text to follow a specific format. The format string is a sequence of special characters that dictates how you are to enter a valid text string.

Format Character

Description

L

Any upper letter

|

Any letter

#

Any digit, sign, or decimal

N

Any upper letter, digit, sign or decimal

n

Any letter, digit, sign or decimal

A

Any upper letter or digit

a

Any letter or digit

0

Any digit

&

Any character

Description

UI_GET_TEXT() creates and displays a dialog box containing a text field. The text that you enter or change is returned as a Result_String. This function is useful for obtaining a text string that conforms to a specified format.

The Result_String will be empty ("") if the Cancel button is selected.

Example

The dialog box presents a default choice of "Green" then prompts the user for a favorite color.

dim color as C
color = ""
color = ui_get_text("Favorite color","Enter your favorite color ", "Green", "&&&&&&&&&&&")
? color
= "Purple"

This example implements a "find by key" function using UI_GET_TEXT().

dim key as C
key = ui_get_text("Find", "Find what")
if (key <> "") then
    topparent.find(key)
end if

Limitations

Desktop applications only.

See Also

• User Interaction (UI) Functions