Properties
CONSTANT |
VALUE DESCRIPTION |
|
BG_SOLID |
0 |
Use a solid background defined by the color in BackgroundColor. |
BG_TRANSPARENT |
1 |
Set the background as transparent. |
(table) A table containing the slideshow object's properties indexed by the following keys:
KEY |
TYPE DESCRIPTION |
|
ImageFiles |
table |
A numerically indexed table containing the paths to the image files to use in the slideshow object. Any existing images in the object will be cleared before adding these. |
BackgroundStyle |
number |
The style of the background to use, defined by one of the following values: |
BackgroundColor |
number |
The background color to use in the object. |
CONSTANT |
VALUE DESCRIPTION |
|
PROPORTIONAL |
0 |
Resize the image so it fits inside the area defined by the object's bounding box. Tip: See the NoEnlarge setting below. |
STRETCH |
1 |
Stretch the image 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, crop the slide. |
CONSTANT |
VALUE DESCRIPTION |
|
BORDER_NONE |
0 |
Don't set any border. |
BORDER_SOLID |
1 |
Use a solid color as the border defined by the color in BorderColor. |
BorderStyle |
number |
The border style to use defined by one of the following values: |
BorderColor |
number |
The border color to use in the object. |
Interval |
number |
The duration to show each slide (in milliseconds). |
AutoStart |
boolean |
True to have the slideshow start automatically, false to not. |
ResizeMode |
number |
The resize mode to use for the slides defined by one of the following values: |
NoEnlarge |
boolean |
True to center the image if it is smaller than the object dimensions when ResizeMode = PROPORTIONAL, false to resize it proportionally to fit the object. |
Loop |
boolean |
True if the slideshow should begin playing from the beginning again whenever the slideshow reaches the end, or false if it should not. Note: If this item is True, the object's On Finished event will not be fired. |
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. |
Shuffle |
boolean |
True if the slides should play in random order, false if they should play in the order defined at design-time. |
Transitions |
boolean |
True if a transition effect should be shown between slides, false if it should not. |
Enabled |
boolean |
True if the slideshow object should be enabled, false if it should not be. |
Visible |
boolean |
True if the slideshow object should be visible, false if it should not be. |
X |
number |
The horizontal position (in pixels) of the top left corner of the slideshow 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 slideshow 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 slideshow object. |
Height |
number |
The height (in pixels) of the slideshow object. |
TooltipText |
string |
The mouseover tooltip of the slideshow object. Tip: If you want a "&" character in the text, you must enter "&&&". |
Cursor |
number |
The mouse cursor that should be displayed when the mouse is over the slideshow object: |
CONSTANT |
VALUE DESCRIPTION |
|
SND_NONE |
0 |
No highlight sound. |
SND_STANDARD |
1 |
Standard highlight sound. |
SND_CUSTOM |
2 |
Custom highlight sound. |
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. |
ResizeLeft |
boolean |
True if the left side of the object should move when the application is resized, false if it should not. |
ResizeRight |
boolean |
True if the right side of the object should move when the application is resized, false if it should not. |
ResizeTop |
boolean |
True if the top of the object should move when the application is resized, false if it should not. |
ResizeBottom |
boolean |
True if the bottom of the object should move when the application is resized, false if it should not. |
HighlightSound |
number |
The type of sound that should be played when the mouse moves over the object. |
HighlightSoundFile |
string |
The path to the object's custom highlight sound file. |
ClickSound |
number |
The type of sound that should be played when the mouse clicks the object. |
ClickSoundFile |
string |
The path to the object's custom click sound file. |
CONSTANT |
VALUE DESCRIPTION |
|
SND_NONE |
0 |
No highlight sound. |
SND_STANDARD |
1 |
Standard highlight sound. |
SND_CUSTOM |
2 |
Custom highlight sound. |
Re t u r n s
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions
SlideShow.SetSize
OverviewExamples
SlideShow.SetSize ( string ObjectName,
number Width,
number Height )
De s cr ip t ion
Sets the size of a slideshow object.
P arame t er s
ObjectName
(string) The name of the slideshow object.