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
SlideShow.GetProperties
OverviewExamples
table SlideShow.GetProperties ( string ObjectName )
De s cr ip t ion
Returns a table containing the properties of a slideshow object.
P arame t er s
ObjectName
(string) The name of the slideshow object.
Re t u r n s
|
CONSTANT |
VALUE DESCRIPTION |
|
|
BG_SOLID |
0 |
The background is the solid color defined in BackgroundColor. |
|
BG_TRANSPARENT |
1 |
The background is transparent. |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
BORDER_NONE |
0 |
The object contains no border. |
|
BORDER_SOLID |
1 |
The border is the solid color defined in BorderColor. |
(table) A table containing the slideshow object's properties, indexed by the following keys:
|
KEY |
TYPE DESCRIPTION |
|
|
ObjectName |
string |
The name of the slideshow object. |
|
ImageFiles |
table |
A numerically indexed table containing the paths to the image files in the slideshow object. |
|
BackgroundStyle |
number |
The style of the background defined by one of the following values: |
|
BackgroundColor |
number |
The background color of the object. |
|
BorderStyle |
number |
The border style defined by one of the following values: |
|
BorderColor |
number |
The border color of the object. |
|
Interval |
number |
The duration each slide is set to show (in milliseconds). |
|
AutoStart |
boolean |
True if the slideshow is set to start automatically, false if it is not. |
|
ResizeMode |
number |
The resize mode for the slides defined by one of the following values: |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
PROPORTIONAL |
0 |
The image is resized so it fits inside the area defined by the object's bounding box. Tip: See NoEnlarge below. |
|
STRETCH |
1 |
The image is stretched to fill the entire area defined by the object's bounding box. |
|
CROP |
2 |
If the slide dimensions are larger than the object's dimensions, the slide will be cropped. |
|
NoEnlarge |
boolean |
True if the image will be centered if it is smaller than the object dimensions when ResizeMode = PROPORTIONAL, false if it will be resized proportionally to fit the object. |
|
Loop |
boolean |
True if the slideshow will begin playing from the beginning again whenever the slideshow reaches the end, or false if not. Note: If this item is True, the object's On Finished event will not be fired. |
|
Shuffle |
boolean |
True if the slides will play in random order, false if they will play in the order defined at design-time. |
|
Transitions |
boolean |
True if a transition effect will be shown between slides, false if it will not. |
|
Enabled |
boolean |
True if the slideshow object is enabled, false if it is not. |
|
Visible |
boolean |
True if the slideshow object is visible, false if it is not. |
|
X |
number |
The horizontal position (in pixels) of the top left corner of the 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 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 |
|
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. |
|
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. |
|
Width |
number |
The width (in pixels) of the slideshow object. |
|
Height |
number |
The height (in pixels) of the slideshow object. |
|
TooltipText |
string |
The mouseover tooltip of the slideshow object. |
|
Cursor |
number |
The mouse cursor that will be displayed when the mouse is over the slideshow object: |
|
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 slideshow object. |
|
HighlightSoundFile |
string |
The path to the slideshow object's custom highlight sound file. If the slideshow 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 slideshow object. |
|
ClickSoundFile |
string |
The path to the slideshow object's custom click sound file. If the slideshow object does not use a custom sound, this value will be an empty string (""). |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
SND_NONE |
0 |
No highlight sound. |
|
SND_STANDARD |
1 |
Standard highlight sound. |
|
SND_CUSTOM |
2 |
Custom highlight sound. |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
SND_NONE |
0 |
No highlight sound. |
|
SND_STANDARD |
1 |
Standard highlight sound. |
|
SND_CUSTOM |
2 |
Custom highlight sound. |
If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.