DlgBillboard.SetProperties

OverviewExamples

DlgBillboard.SetProperties (

number ControlID,

table Properties )

Description

Sets the properties of a billboard control on the current screen.

Parameters

ControlID

(number) The numeric ID of the billboard control.

Properties

(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 to use in the billboard control. Any existing images in the control will be cleared before adding these.

BackgroundStyle

number

The style of the background to use, defined by one of the following values:

CONSTANT	VALUE	DESCRIPTION
BG_SOLID	0	Use a solid background defined by the color in BackgroundColor.
BG_TRANSPARENT	1	Set the background as transparent.

BackgroundColor

number

The background color to use in the control.

BorderStyle

number

The border style to use defined by one of the following values:

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.

BorderColor

number

The border color to use in the control.

Interval

number

The duration to show each image (in milliseconds).

AutoStart

boolean

True to have the billboard control start automatically, false to not.

ResizeMode

number

The resize mode to use for the images defined by one of the following values:

CONSTANT	VALUE	DESCRIPTION
PROPORTIONAL	0	Resize the image so it fits inside the area defined by the control's bounding box. Tip: See the NoEnlarge setting below.
STRETCH	1	Stretch the image 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, crop the image.

NoEnlarge

boolean

True to center the image if it is smaller than the control dimensions when ResizeMode = PROPORTIONAL, false to resize it proportionally to fit the control.

Loop

boolean

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

Shuffle

boolean

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

Enabled

boolean

True if the billboard control should be enabled, false if it should not be.

Visible

boolean

True if the billboard control should be visible, false if it should not be.

number

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

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

number

The vertical position (in pixels) of the top left corner of the billboard 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 control.

Height

number

The height (in pixels) of the control.

Returns

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.