IPrxJsPlugin.PluginId

Syntax

PluginId: String;

Description

The PluginId property determines an identifier of JS plugin that is used to create a sheet.

Comments

Plugin identifier should correspond with the value specified in the type attribute contained:

In the <plugins> section of the PP.xml configuration file for the web application.
In the "plugins" field of the DBA.config.json configuration file for the designer of business applications.

NOTE. Viewing and editing of the created sheet is available only in the web application. An appropriate message will be displayed on opening the sheet in the desktop application.

Example

Executing the example requires that the repository contains a regular report with the REPORT, to which a plugin is connected with the PP.Ui.Prx.MyLabel identifier.

Add links to the Metabase, Report system assemblies.

Sub UserProc;
Var
    MB: IMetabase;
    MObj: IMetabaseObject;
    Report: IPrxReport;
    Sheets: IPrxSheets;
    Sheet: IPrxSheet;
    Plugin: IPrxJsPlugin;
Begin
    MB := MetabaseClass.Active;
    // Get regular report
    MObj := MB.ItemById("REPORT").Edit;
    Report := MObj As IPrxReport;
    // Add a new sheet with plugin
    Sheets := Report.Sheets;
    Sheet := Sheets.Add("Sheet with plugin", PrxSheetType.JsPlugin);
    Plugin := Sheet As IPrxJsPlugin;
    Plugin.PluginId := "PP.Ui.Prx.MyLabel";
    // Save changes
    MObj.Save;
End Sub UserProc;

After executing the operations, a new sheet with a plugin will be added.