Flash.GetProperties

OverviewExamples

table Flash.GetProperties (

string ObjectName )

Description

Returns a table containing the properties of a flash object.

Parameters

ObjectName

(string) The name of the flash object.

Returns

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

KEY

TYPE

DESCRIPTION

ObjectName

string

The name of the flash object.

FlashFile

string

The currently loaded flash file.

Alignment

number

How the flash movie is aligned to the flash object:

CONSTANT

VALUE

DESCRIPTION

ALIGN_DEFAULT

0

Default.

ALIGN_TOP

1

Align the flash movie to the top of the flash object.

ALIGN_LEFT

2

Align the flash movie to the left of the flash object.

ALIGN_BOTTOM

3

Align the flash movie to the bottom of the flash object.

ALIGN_RIGHT

4

Align the flash movie to the right of the flash object.

ALIGN_TOP_LEFT

5

Align the flash movie to the top-left of the flash object.

ALIGN_TOP_RIGHT

6

Align the flash movie to the top-right of the flash object.

ALIGN_BOTTOM_LEFT

7

Align the flash movie to the bottom-left of the flash object.

ALIGN_BOTTOM_RIGHT

8

Align the flash movie to the bottom-right of the flash object.

Menu

number

The right-click context menu:

CONSTANT

VALUE

DESCRIPTION

MENU_STANDARD

0

Standard context menu.

MENU_FULL

1

Full context menu.

Quality

number

The quality that the current flash movie is displayed at:

CONSTANT

VALUE

DESCRIPTION

QUALITY_LOW

0

Gives priority to playback speed over appearance. Anti-aliasing is turned off.

QUALITY_HIGH

1

Gives priority to appearance over playback speed. Anti-aliasing is turned on.

QUALITY_AUTO_LOW

2

Emphasizes speed at first, but improves appearance whenever possible. Playback begins with anti-aliasing turned off; if the Player determines that the system can handle it, it turns anti-aliasing on.

QUALITY_AUTO_HIGH

3

Emphasizes speed and appearance equally at first, but sacrifices appearance for the sake of speed if necessary. Playback begins with anti-aliasing turned on, but it will be turned off if the frame rate drops below an acceptable level.

ScalingMode

number

The style of the flash object:

CONSTANT

VALUE

DESCRIPTION

SHOW_ALL

0

The entire movie is visible in the area defined by the object's bounding box without distortion, while maintaining the original aspect ratio of the movie. Borders may appear on two sides of the movie.

NO_BORDER

1

The movie is scaled to fill the area defined by the object's bounding box without distortion, while maintaining the original aspect ratio of the movie. Any part of the movie that falls outside the area defined by the object's bounding box is cropped.

EXACT_FIT

2

The movie is resized to fill the area defined by the object's bounding box, ignoring the movie's original aspect ratio. The movie may appear distorted as a result.

OverrideBackground

boolean

True if the color specified in BGOverrideColor should override the background of the flash movie, false if it should not.

BGOverrideColor

number

The color being used to replace the flash background with if OverrideBackground is set to true.

DeviceFont

boolean

If true, the flash object will substitute installed system fonts for any fonts used in the Flash movie. Any text whose fonts are substituted will appear aliased (rough) regardless of the Quality setting. If the necessary fonts are not installed, the text will be rendered in the normal anti-aliased (smooth) way.

AutoStart

boolean

True if the flash movie will automatically begin to play as soon as the page or dialog is opened, false if it is not.

Loop

boolean

True if the movie will loop, false if it will not.

Enabled

boolean

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

Visible

boolean

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

X

number

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

Height

number

The height (in pixels) of the flash object.

TooltipText

string

The mouseover tooltip of the flash 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.

WindowHandle

number

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

If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.

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