This repository was archived by the owner on Aug 31, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 226
Expand file tree
/
Copy pathask.lcdoc
More file actions
110 lines (80 loc) · 3.4 KB
/
ask.lcdoc
File metadata and controls
110 lines (80 loc) · 3.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
Name: ask
Type: command
Syntax: ask [<iconType>] <prompt> [with <defaultResponse>] [titled <windowTitle>] [as sheet]
Summary:
Displays a <dialog box> with a prompt, a text box for the user to enter
a response, and OK and Cancel buttons.
Introduced: 1.0
OS: mac, windows, linux, ios, android
Platforms: desktop, mobile
Example:
ask "What is your name?"
Example:
ask "Please enter your occupation:" with "Geek"
Example:
ask field "Prompt" with firstGuess titled "Guess!"
Example:
ask myPrompt as sheet
Example:
ask "Please say hello:" with "DEFAULT" titled "Hello World"
Example:
ask information "Please enter your user name."
Example:
# formatted prompt text
put "Enter your <font color='red'><b>last name only</b></font>." into tPromptText
ask tPromptText
Parameters:
iconType (enum):
The icon that is displayed on the left side of the dialog box. If you do
not specify an icon, none is displayed. iOS and Android do not support
<iconType>.
- information: Non-critical notification
- question: Request for information from the user
- error: Notification of error or failure condition
- warning: Notification of unexpected or abnormal condition
prompt (string):
A string of formatted (or unformatted) text.
defaultResponse (string):
A string, and is placed in the text box when the dialog box appears. If
no defaultResponse is specified, the text box is empty when the dialog
box appears.
windowTitle:
Appears in the title bar of the dialog box. If no windowTitle is given,
the title bar is blank.
It:
The contents of the text box is placed in the it <variable>.
The result:
If the user cancels the <dialog box|dialog>, the <it> <variable> is set
to empty and the <result> <function> <return|returns> "cancel".
Description:
Use the <ask> <command> when a <handler> needs to get information from
the user before continuing.
If the ask...as sheet form is used, the dialog box appears as a sheet on
OS X systems. On other systems, the as sheet form has no effect and the
dialog box appears normally. Attempting to open a sheet from within
another sheet displays the second stack as a <modal dialog box> instead.
You can format the prompt text using <HTML>-style tags as described in
the <HTMLText> property.
>*Cross-platform note:* On <OS X|OS X systems>, there is no image for
> the question icon.
Therefore, the information icon appears instead. In addition, the image
specified by the <gRevAppIcon> appears if you do not specify an
<iconType>. If you specify an iconType, the image specified by the
<gRevSmallAppIcon> appears instead, along with the standard icon
specified by the <iconType>.
>*Cross-platform note:* Mobile does not support <iconType> and 'as
> sheet'.
The ask...as sheet form was introduced in version 2.0.
The ability to provide formatted text for the prompt was introduced in
version 2.0.
Changes:
The ability to specify an <iconType> was added in version 2.0. In
previous versions, no icon was displayed.
References: answer (command), ask file (command), ask password (command),
modal (command), sheet (command), ask file with type (command),
function (control structure), result (function), return (glossary),
OS X (glossary), variable (glossary), handler (glossary),
modal dialog box (glossary), dialog box (glossary), command (glossary),
HTML (glossary), gRevAppIcon (keyword), it (keyword),
gRevProfileReadOnly (keyword), gRevSmallAppIcon (keyword),
dialogData (property), HTMLText (property)