DlgBillboard.GetProperties

 OverviewExamples

table DlgBillboard.GetProperties ( 

number ControlID )

Description

Returns a table containing the properties of a billboard control.

Parameters

ControlID

(number) The numeric ID of the billboard control.

Returns

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

KEY

TYPE

DESCRIPTION

ImageFiles

table

A numerically indexed table containing the paths to the image files in the control.

BackgroundStyle

number

The style of the background defined by one of the following values:

CONSTANT

VALUE

DESCRIPTION

BG_SOLID

0

The background is the solid color defined in BackgroundColor.

BG_TRANSPARENT

1

The background is transparent.

BackgroundColor

number

The background color of the control.

BorderStyle

number

The border style defined by one of the following values:

CONSTANT

VALUE

DESCRIPTION

BORDER_NONE

0

The control contains no border.

BORDER_SOLID

1

The border is the solid color defined in BorderColor.

BorderColor

number

The border color of the control.

Interval

number

The duration each image is set to show (in milliseconds).

AutoStart

boolean

True if the billboard control is set to start automatically, false if it is not.

ResizeMode

number

The resize mode for the images 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 control's bounding box. Tip: See NoEnlarge below.

STRETCH

1

The image is stretched to fill the entire area defined by the control's bounding box.

CROP

2

If the image dimensions are larger than the control's dimensions, the image will be cropped.

NoEnlarge

boolean

True if the image will be centered if it is smaller than the control dimensions when ResizeMode = PROPORTIONAL, false if it will be resized proportionally to fit the control.

Loop

boolean

True if the billboard control will begin playing from the beginning again whenever it reaches the end, or false if not.

Shuffle

boolean

True if the images 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 images, false if it will not.

Enabled

boolean

True if the billboard control is enabled, false if it is not.

Visible

boolean

True if the billboard control is visible, false if it is not.

X

number

The horizontal position (in pixels) of the top left corner of the control in relation to the current screen.

Note: The top left corner of the current screen has an X value of 0.

Y

number

The vertical position (in pixels) of the top left corner of the control in relation to the current screen.

Note: The top left corner of the current screen has a Y value of 0.

Width

number

The width (in pixels) of the billboard control.

Height

number

The height (in pixels) of the billboard control.

If the control 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