|

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


image

image

QuickTime.GetProperties

OverviewExamples

table QuickTime.GetProperties ( string ObjectName )


De s cr ip t ion


Returns a table containing the properties of a QuickTime object.


P arame t er s


ObjectName


(string) The name of the QuickTime object.


Re t u r n s


image

(table) A table containing the object's properties, indexed by the following keys:



KEY


TYPE


DESCRIPTION


ObjectName


string


The name of the QuickTime object.


MovieFile


string


The currently loaded media file.


SizingMode


number


How the media is displayed within the QuickTime control: CONSTANT VALUE


DESCRIPTION


CONSTANT


VALUE DESCRIPTION


bsNone


0


No border is displayed.


bsPlain


1


A solid blank line is shown.


bs3D


2


The standard 3D/sunken border is shown. On 64-bit versions of Windows this style may not display properly.


qtMovieFitsControl


1


The media is resized to fill the area defined by the object's bounding box. This setting ignores the media's original aspect ratio.


qtMovieFitsControlMaintainAspectRatio


2


The media is fit the within the object's bounding box while maintaining the original aspect ratio for the file.


qtMovieCenteredInControl


3


The media is centered at full size within the object's bounding box.



BorderStyle


number


The type of border shown around the object:


AutoStart


boolean


True if the QuickTime object will automatically play the loaded media as soon as the page or dialog is shown, false if it will not.


Loop


boolean


True if the media will restart when it ends, false if it will not.


CONSTANT


VALUE DESCRIPTION


SND_NONE


0


No highlight sound.



ShowControls


boolean


True if the control panel will be shown, false if it will not be.


UseBackgroundColor


boolean


True if the color specified in BackgroundColor will be used as the background of the media, false if it will not.


BackgroundColor


number


The color being used to replace the media background with if

UseBackgroundColor is set to true.


Enabled


boolean


True if the QuickTime object is enabled, false if it is not.


Visible


boolean


True if the QuickTime object is visible, false if it is not.


X


number


The horizontal position (in pixels) of the top left corner of the QuickTime 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 QuickTime 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 QuickTime object.


Height


number


The height (in pixels) of the QuickTime 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 QuickTime object.



HighlightSoundFile


string


The path to the QuickTime object's custom highlight sound file. If the 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 QuickTime object.


ClickSoundFile


string


The path to the QuickTime object's custom click sound file. If the object does not use a custom sound, this value will be an empty string ("").


WindowHandle


number


The integer value that represents the object's window. (Commonly referred to as an hWnd.)



SND_STANDARD


1


Standard highlight sound.


SND_CUSTOM


2


Custom highlight sound.


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.


|