Images Property

Article
04/02/2024

Version: Available or changed with runtime version 1.0.

Specifies the list of images to include in the control add-in.

Applies to

Control Add In

Property values

A list of comma-separated strings that represents paths to image files. The default is blank, with no images being used by the control add-in.

You can specify multiple files within the same path string by using a combination of a valid literal path and wildcard characters (* and ?). However, it doesn't support regular expressions.

Remarks

The Images property specifies image resources that are referenced by the control add-in scripts. Any specified images must be of a supported web format and extension, such as .PNG or .GIF.

Images can be either external resources referenced using a URL or can be embedded within the extension. Embedded images must be added to the extension project folder in Visual Studio Code and referenced using a relative path. At runtime, the path to an embedded can be obtained using the GetImageResource method method. Unlike scripts and stylesheets, images are loaded on demand when they're first used in code. Since images are stored in the application after the extension is deployed, it's recommended to keep the number of image files and combined image size to a minimum.

Syntax example

Images = 'https://fabrikam.com/banner.png',
              'images/map.png',
              'images/*.png';

Image paths on control add-ins can be relative to the control add-in source file

APPLIES TO: Business Central 2024 release wave 1 and later

Starting from runtime 13, you can store control add-in resources in a location relative to the file that contains the source code of the control add-in. This provides more flexibility in organizing and locating control add-in resources.

When the system needs to locate these resources, it follows a specific search order; first, it looks for the resources in a location relative to the root of the project. If the resources aren't found there, it then searches in a location relative to the source file of the control add-in.

The following example shows the two options for organizing control add-in resources; scripts, images, and stylesheets. For the file MyControlAddIn.al, the resources are organized in two different ways.

Organizing resources example

For the file MyControlAddIn.al.

controladdin MyControlAddIn
{
    Scripts = './js/myscript.js';
    Images = './png/myimage.png';
    StyleSheets = 'css/mystyle.css';
    ...
}

The resources are relative to the project root:

.
[src]
    MyControlAddIn.al
[resources]
    [js]
        myscript.js
    [png]
        myimage.png
    [css]
        mystyle.css
app.json

The resources are relative to the control add-in source:

.
[src]
    MyControlAddIn.al
    [resources]
        [js]
            myscript.js
        [png]
            myimage.png
        [css]
            mystyle.css
app.json