PlusWnd::ImageElmt_SetImageFile

The PlusWnd::ImageElmt_SetImageFile function sets the image file to be displayed by an ImageElement.

Syntax

ImageElmt_SetImageFile(
    [string] ElementId,
    [string] File
);

Parameters

ElementId

[string] Unique identifier of the element.

File

[string] Path to the image's file to use. It can be a PNG, a JPG, a GIF or a BMP file. The path is relative to the script's "Images" sub-directory by default, to override this behavior, prefix the path with "\". Example: "\C:\directory\picture.png".

Return Value

No value is returned by this function.

This function typically fails for the following reason:

• The PlusWnd object refers to a window that has been destroyed.

Remarks

If a picture appears deformed when displayed, it may be the result of the "Mosaic" attribute of the image element combined with the specified Width and Height.

Function Information

See Also

PlusWnd Object.