ResultVariable
When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.
See also: Related Actions
Hotspot.GetProperties
OverviewExamples
table Hotspot.GetProperties ( string ObjectName )
De s cr ip t ion
Returns a table containing the properties of a hotspot object.
P arame t er s
ObjectName
(string) The name of the hotspot object.
Re t u r n s
|
CONSTANT |
VALUE DESCRIPTION |
|
|
CURSOR_ARROW |
0 |
Standard mouse arrow cursor. |
|
CURSOR_HAND |
1 |
Hand cursor. |
|
CURSOR_BLACK_ARROW |
2 |
Black arrow cursor. |
|
CURSOR_CROSSHAIR |
3 |
Crosshair cursor. |
|
CURSOR_EXPLORE |
4 |
Explore cursor. |
|
CURSOR_HELP |
5 |
Help cursor. |
(table) A table containing the hotspot's properties, indexed by the following keys:
|
KEY |
TYPE DESCRIPTION |
|
|
ObjectName |
string |
The name of the hotspot object. |
|
Enabled |
boolean |
True if the hotspot object is enabled, false if it is not. |
|
X |
number |
The horizontal position (in pixels) of the top left corner of the hotspot object in relation to the current page or dialog. Note: The top left corner of the current page or dialog has an X value of 0 |
|
Y |
number |
The vertical position (in pixels) of the top left corner of the hotspot object in relation to the current page or dialog. Note: The top left corner of the current page or dialog has a Y value of 0 |
|
Width |
number |
The width (in pixels) of the hotspot object. |
|
Height |
number |
The height (in pixels) of the hotspot object. |
|
TooltipText |
string |
The mouseover tooltip of the hotspot object. |
|
Cursor |
number |
The mouse cursor that will be displayed when the mouse is over the hotspot object: |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
SND_NONE |
0 |
No highlight sound. |
|
SND_STANDARD |
1 |
Standard highlight sound. |
|
SND_CUSTOM |
2 |
Custom highlight sound. |
|
CURSOR_MAGNIFY |
6 |
Magnify cursor. |
|
CURSOR_MEDIA |
7 |
Media cursor. |
|
CURSOR_MONEY |
8 |
Money cursor. |
|
CURSOR_NOTEPAD |
9 |
Notepad cursor. |
|
CURSOR_PENCIL |
10 |
Pencil cursor. |
|
CURSOR_PRINTER |
11 |
Printer cursor. |
|
CURSOR_SPEAKER |
12 |
Speaker cursor. |
|
CURSOR_UP_ARROW |
13 |
Up arrow cursor. |
|
ResizeLeft |
boolean |
True if the left side of the object will move when the application is resized, false if it is not. |
|
ResizeRight |
boolean |
True if the right side of the object will move when the application is resized, false if it is not. |
|
ResizeTop |
boolean |
True if the top of the object will move when the application is resized, false if it is not. |
|
ResizeBottom |
boolean |
True if the bottom of the object will move when the application is resized, false if it is not. |
|
HighlightSound |
number |
The type of sound that will be played when the mouse moves over the hotspot object. |
|
HighlightSoundFile |
string |
The path to the hotspot object's custom highlight sound file. If the hotspot object does not use a custom sound, this value will be an empty string (""). |
|
ClickSound |
number |
The type of sound that will be played when the mouse clicks the hotspot object. |
|
ClickSoundFile |
string |
The path to the hotspot object's custom click sound file. If the hotspot object does not use a custom sound, this value will be an empty string (""). |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
SND_NONE |
0 |
No click sound. |
|
SND_STANDARD |
1 |
Standard click sound. |
|
SND_CUSTOM |
2 |
Custom click sound. |
If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.