Scripts Property

Artikel
04/02/2024

Version: Available or changed with runtime version 1.0.

Specifies the list of scripts to include in the control add-in. The scripts could be local files in the package or references to external files using the http or the https protocol.

Applies to

Control Add In

Property values

A list of comma-separated strings that represent paths to script files. The default is blank, with no scripts 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

Although this property is optional, the control add-in must either specify the StartupScript property or specify one or more scripts. Scripts can be either external resources referenced using a URL or can be embedded within the extension. Embedded script files must be added to the extension project folder in Visual Studio Code and referenced using a relative path. For security and usability reasons, it's recommended to reference any external scripts by using the HTTPS protocol. Scripts are loaded immediately when the control add-in is initialized.

Syntax example

Scripts = 'https://code.jquery.com/jquery-2.1.0.min.js',
              'js/main.js',
              'scripts/*.js';

Scripts 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 = './images/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