• 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_NUMBER Function

Syntax

Arguments

title

The title of the dialog box.

prompt

The descriptive text above the data entry field.

default_choice

Optional. Default = "". The number text that will be in the Number text box when the dialog box first appears.

format_string

Optional. Default = "". To force the entered number to follow a specific format, supply the optional Format String parameter. The format string is a sequence of special characters that dictates how you are to enter a valid text string.

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_NUMBER() creates and displays a dialog box containing a number field. The number that you enter or change is returned as a Result String. This function is useful for obtaining a number value that conforms to a specified format. Use the VAL()function on the Result_String to get the number. Prompt user for number.

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

Example

This script plays a guessing game. The computer picks a random number from 0 to 100 and the user tries to guess it.

user_number = -1
secret_number = int(rand() *100)
while user_number <> secret_number
    user_number = val(ui_get_number("Game","What is your guess? (0-100)","0","000"))
    if user_number > secret_number then
        ui_msg_box("Game", "That number is too big.")
    elseif user_number < secret_number then
        ui_msg_box("Game", "That number is too small.")
    end if
end while
ui_beep()
ui_msg_box("Game","Congratulations! The number is:" + str(secret_number))

Limitations

Desktop applications only.

See Also

• User Interaction (UI) Functions