Billboard Control

The billboard control allows you to incorporate billboards (an image slideshow, or single images) on your custom screens or custom progress screens. The billboard control contains many settings that can be configured to suit your presentation, such as: background style, border style, image duration, resize modes, auto-start, looping, shuffle, image transition effects, and many more.

Additional features of the billboard control can be found in the following two categories:

 

Notification Messages

A notification message is triggered whenever the user interacts with a control, or whenever user interaction affects a control in some way. Each notification message consists of a number that identifies the type of interaction that has occurred, and a table containing details specific to that type of interaction. These two values are passed to the screen's On Ctrl Message event as the event variables e_MsgID and e_Details.

Note: Notification messages are not triggered when actions interact with this control.

(number) e_MsgID
A numeric constant that represents the specific notification message that was fired by the screen control. See the e_MsgID column below for all possible message ids that can be fired by a billboard control.

(table) e_Details
A table of a
dditional details that may be passed by the control when certain notification messages are fired. See the e_Details column below for the kinds of details that are returned and the table indexes that you can use to access them.

e_MsgID

e_Details

Description

MSGID_CLICKED

nil

Fired when the billboard control is clicked.

MSGID_ONPLAY

nil

Fired when the billboard control begins to play.

MSGID_ONPAUSED

nil

Fired when the billboard control is paused.

MSGID_ONFINISHED

nil

Fired when the billboard control reaches the end. Note: If the Loop setting is selected, this message will not be fired.

MSGID_ONIMAGECHANGED

(number) Index - The 1-based index of the image that was changed to in the billboard (currently shown).

(string) FilePath - The full path to the image file that was changed to in the billboard (currently shown).

Fired each time the image changes in the billboard control.

Related Actions

The following actions are available for interacting with a billboard control:

 

DlgBillboard.AddImage

DlgBillboard.DeleteImage

DlgBillboard.FillFromFolder

DlgBillboard.GetCurrentImage

DlgBillboard.GetImageCount

DlgBillboard.GetImagePath

DlgBillboard.GetPos

DlgBillboard.GetProperties

DlgBillboard.GetSize

DlgBillboard.GoToImage

DlgBillboard.IsEnabled

DlgBillboard.IsVisible

DlgBillboard.Navigate

DlgBillboard.Pause

DlgBillboard.Play

DlgBillboard.SetEnabled

DlgBillboard.SetPos

DlgBillboard.SetProperties

DlgBillboard.SetSize

DlgBillboard.SetVisible