DlgBillboard.AddImage

OverviewExamples

number DlgBillboard.AddImage (

number ControlID,

string FilePath,

number Position = -1 )

Description

Adds an image to a billboard control.

Parameters

ControlID

(number) The numeric ID of the billboard control.

FilePath

(string) The path to the image file you want to add.

Note: The following image formats are supported in the billboard control: JPG, BMP, TIFF, GIF, PNG, PCX, and TGA. If you require alpha transparency, use 32-bit .PNG format.

Tip: You can use a hardcoded path or add images as primer files and reference them from _TempLaunchFolder.

Position

(number) The 1-based position to add the new image. Use -1 to add the image to the end of the control's image list.

Returns

(number) The 1-based position where the image was added. If an error occurs, -1 is 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.