Description: Renders the Web Designer component to the <div> element with given selector using the specified DesignerSettings object.

Parameter (Type):

Return Type: Promise<DesignerAPI>

Required: Yes

GrapeCity.ActiveReports.WebDesigner.create('designer-id', designerSettings);

Description: Returns the DesignerAPI of the previously created instance of the Web Designer component.

Parameter (Type):

Return Type: DesignerAPI | undefined

Required: Yes

Description: Returns the DesignerAPI of the previously created instance of the Web Designer component.

Parameter (Type):

Return Type: void

Required: Yes

Description: Refers to the bundle language.

Return Type: string

Required: Yes

Description: Refers to the bundle namespace.

Return Type: string

Required: Yes

Description: Refers to the localization resources.

Return Type: Record<string, any>

Required: Yes

Description: Contains application-related APIs.

Required: Yes

about

GrapeCity.ActiveReports.Designer.apiOf('designer-id').app.panels.menu.open('document-explorer');

GrapeCity.ActiveReports.Designer.apiOf('designer-id').app.panels.sidebar.open('dataTab');

focus()

GrapeCity.ActiveReports.Designer.apiOf('designer-id').app.focus();

editor()

GrapeCity.ActiveReports.Designer.apiOf('designer-id').app.editor.canUndo();

Description: This object includes functions allowing you to create, open, save reports, and more.

Return Type: DocumentsAPI

Required: Yes

Description: Allows to utilize the built-in notifications system in the Web Designer component.

Return Type: NotificationsAPI

Required: Yes

Description: Indicates whether the report has unsaved changes.

Return Type: boolean

Required: Yes

var hasUnsavedChanges = GrapeCity.ActiveReports.Designer.apiOf('designer-id').documents.hasUnsavedChanges();
if (hasUnsavedChanges) console.log('Currently edited report has unsaved changes.');

Description: Indicates whether the report was saved at least once.

Return Type: boolean

Required: Yes

Description: Returns information about the currently edited report in the Web Designer component.

Return Type: CurrentDocumentInfo      

Required: Yes 

var reportInfo = GrapeCity.ActiveReports.Designer.apiOf('designer-id').documents.info();
console.log(`Report "${reportInfo.name}" is currently edited.`);

Description: Creates a new report to be edited in the Web Designer component using the specified CreateReportOptions object.

Parameter (Type):

1. options (optional): CreateDocumentOptions

Return Type: Promise<CreateDocumentInfo> 

Required: Yes      

var api = GrapeCity.ActiveReports.Designer.apiOf('designer-id');
api.documents.create().then(() => {
        console.log('An empty RDL report is created.');
})

Description: Shows the Open Report dialog box in the Web Designer component.

Return Type: void

Required: Yes

Description: Opens an existing report to be edited in the Web Designer component with a specified id. Optionally, you can pass the report name and content, else it will be loaded from the server.

Parameter (Type):

Return Type: Promise<OpenDocumentInfo>

Required: Yes

var api = GrapeCity.ActiveReports.Designer.apiOf('designer-id');
api.documents.openById('MyReport.rdlx', { platform: 'rdlx', type: 'report', subType: 'cpl'}).then(() => {
  console.log('An existing report "MyReport.rdlx" is opened.');
});
var reportContent = { Type: 'report', Body: { ReportItems: [ {Type: 'textbox', Name: 'TextBox1', Width: '5in', Height: '1in' } ] }};
api.documents.openById('NewReport.rdlx', { platform: 'rdlx', type: 'report', subType: 'cpl'}, 'NewReport', reportContent).then(() => {
  console.log('New report with one textbox created and opened.');
});

Description: Saves the currently edited report in the Web Designer component. If the report is new, then the Save As dialog box will be opened.

Return Type: void

Required: Yes

Description: Opens the Save As dialog box in the Web Designer component.

Return Type: void

Required: Yes

Description: Saves the currently edited report in the Web Designer component using the specified id.

Parameter (Type):

• id (optional): string
• name (optional): string

Return Type: Promise<SaveDocumentInfo>

Required: Yes

var api = GrapeCity.ActiveReports.Designer.apiOf('designer-id');
api.documents.saveById('MyReport.rdlx')

Description: Saves the report currently edited in the Web Designer component using the specified name.

Parameter (Type):

Return Type: Promise<SaveDocumentInfo>

Required: Yes

var api = GrapeCity.ActiveReports.Designer.apiOf('designer-id');
api.documents.saveById('MyReport.rdlx')

'rpx'

 'report'

'rdlx'

'report'

 'fpl'

'rdlx'

'report'

'cpl'

 'rdlx'

 'report'

 'msl'

 'rdlx'

'dashboard'

'msl'

Description: Sends a notification of the specified level, including caption and content.

Parameter (Type):

1. 1.      where
      1.  level refers to notification level. It determines the color and icons used for the notifications.
      2.  caption refers to notification caption. It is displayed when the notification pops up by default, then used as a title in Notification Details view.
      3.  content refers to notification content. It is only visible when the Notification Details are open.

Return Type: void

Required: Yes

Description: Sends a general notification, which can be used to notify when any user-initiated action is complete.

Parameter (Type):

Return Type: void

Required: Yes

Description: Sends an error notification.

Parameter (Type):

Return Type: void

Required: Yes

Description: Sends a warning notification.

Parameter (Type):

Return Type: void

Required: Yes

Description: Dismisses all notifications.

Return Type: void

Required: Yes

Return Type: string

Required: Yes

Return Type: string

Required: Yes

Return Type: string

Required: Yes

Description: Indicates the unique identifier for the Web Designer instance. This is required if there are multiple instances of the Web Designer on the same page.

Return Type: string

Required: Yes

Description: Specifies the language to use for the Web Designer component. If language is not specified, browser preferences are used. The localization is available in following languages: 'en', 'ja', 'zh', 'zh-TW', 'es', 'ko', and 'pl'.  

designerSettings.language = 'ja';

Return Type: string

Required: Yes

Description: Specifies the list of fonts displayed in the Font editors all over the Web Designer component, and supports plain strings, label-value pairs, headers, and splitters. If fonts are not specified explicitly here, the default list of fonts is used:
'Arial', 'Arial Black', 'Comic Sans MS', 'Courier New', 'Geneva', 'Georgia', 'Helvetica',  'Impact', 'Lucida Console', 'Meiryo', 'Meiryo UI', 'MingLiU', 'MingLiU-ExtB', 'MS Gothic', 'MS Mincho', 'MS PGothic', 'MS PMincho', 'MS Song', 'MS UI Gothic', 'NSimSun', 'Osaka', 'PMingLiU', 'PMingLiU-ExtB', 'SimSun', 'SimSun-ExtB', 'Song', 'Tahoma', 'Times New Roman', 'Trebuchet MS', 'Verdana', and 'Yu Gothic'.

Return Type: (string | Font | FontHeader)[]

Required: Yes

designerSettings.fonts = [{ header: 'Questionable Choice' }, { label: 'Pretty Font', value: 'Comic Sans MS' }, { header: '' }, 'Arial', 'Courier New', 'Times New Roman'];

Description: Specifies the list of supported image mime-types in the Web Designer component.

Return Type: string[]

Required: Yes

Description: Specifies the default measurement units for the Web Designer component. The default unit is inches.

Return Type: 'in' | 'cm'

Required: Optional

designerSettings.units = 'cm';

Description: By default, the lockLayout property is set to 'false'. However, when you set this property to 'true', it enables you to modify the properties of existing report items. Operations that can modify the report layout structure are not possible, such as adding a new report item or deleting an existing one, and others.

Return Type: boolean

Required: Yes

designerSettings.lockLayout = true;

Return Type: { id: string; type: SupportedDocumentType; };

Required: Optional

Description: By default, the storeUnsavedReport property is set to 'true'. In this case, the last unsaved report can be restored if the browser tab or browser itself gets accidentally closed. However, if the storeUnsavedReport property is set to 'false', the aforementioned functionality is not available.

Return Type: boolean

Required: Yes

designerSettings.storeUnsavedReport = false;

Description: By default, the storeUserPreferences property is set to 'true'. In this case, the user preferences will be saved to the browser storage. However, if the storeUnsavedReport property is set to 'false', the aforementioned functionality is not available.

Return Type: boolean

Required: Yes

designerSettings.storeUserPreferences = false;

Description: By default, the disableFocusTimer property is set to 'true'. In such a case, the focused elements (like buttons) are highlighted only for a short period after the Tab key is pressed. However, if the disableFocusTimer property is set to 'false', the focus highlighting timer on the buttons is disabled for better accessibility.

Return Type: boolean

Required: Yes

Description: Disable the usage of the system clipboard. Copy-paste between designer instances will work only in the same browser in the same domain.

Return Type: boolean

Required: Yes

Description: Return filtered array of descriptors in the order in which descriptors should be rearranged.

Parameter (Type):

descriptors: PropertyDescriptor[]

item: Record<string, any>

platform: 'rdlx' | 'rpx'

Return Type: PropertyDescriptor[]

Required: Optional

GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
  filterProperties: (descriptors, item, platform) => platform === 'rpx' ? [] : descriptors,
});

Description: Settings available for the Editors in the Web designer component.

Required: Yes

rulers

Description: Specifies the size of the Grid Size editor. By default, 'in' is used.

Return Type: string

Required: Optional

Description: Specifies whether the grids must be shown or hidden in the Web Designer component.

Return Type: boolean

Required: Optional

Description: Specifies whether to display the Snap To Grid option in the Web Designer component. The default value for this property is 'false'.

Return Type: boolean

Required: Optional

Description: Specifies whether to display the Snap To Guides option in the Web Designer component. The default value for this property is 'false'.

Return Type: boolean

Required: Optional

Description: Settings for the App bar in the Web Designer component.

Required: Yes

visible

saveButton

designerSettings.appBar.saveButton.visible = false;

saveAsButton

designerSettings.appBar.saveAsButton.visible = false;

openButton

designerSettings.appBar.openButton.visible = true;

insertTab

designerSettings.appBar.insertTab.visible = true;

homeTab

designerSettings.appBar.homeTab.visible = false;

contextActionsTab

designerSettings.appBar.contextActionsTab.visible = false;

parametersTab

designerSettings.appBar.parametersTab.visible = false;

scriptTab

designerSettings.appBar.scriptTab.visible = false;

aboutButton

designerSettings.appBar.aboutButton.visible = false;

Description: Settings for the Tool Bar.

Required: Yes

visible

Description: Settings for menus in the Web Designer component.

Required: Yes

visible

toolBox

designerSettings.menu.toolBox.visible = false;

documentExplorer

designerSettings.menu.documentExplorer.visible = false;

groupEditor

designerSettings.menu.groupEditor.visible = false;

layerEditor

designerSettings.menu.layerEditor.visible = false;

Description: Settings for the Status bar in the Web Designer component.

Required: Yes

visible

toggleUnitsButton

toggleGridButton

gridSizeEditor

rulersButton

propertiesModeButton

Description: Settings for the Property grid in the Web Designer component.

Required: Yes

propertiesTab

mode

sort

Description: Settings for the Document API in the Web Designer component.

Required: Yes

fileView

designerSettings.fileView.visible = false;

designerSettings.fileView.aboutButton.visible = false;

handlers

Description: Settings related to data in the Web Designer component.

Required: Yes

dataTab

dataSources

designerSettings.data.dataSources.visible = false;

designerSettings.data.dataSources.canModify = true;

designerSettings.data.dataSources.options.predefinedProviders = ['SQL', 'JSON'];

designerSettings.data.dataSources.options.oleDbProviders = ['Microsoft.Jet.OLEDB.4.0', 'SQLOLEDB.1']

dataSets

designerSettings.data.dataSets.visible = false;

designerSettings.data.dataSets.canModify = true;

parameters

designerSettings.data.parameters.visible = false;

designerSettings.data.parameters.canModify = false;

commonValues

designerSettings.data.commonValues.visible = false;

Description: Style settings for Section Reports in the Web Designer component.

Required: Yes

stylesTab

stylesheet

Description: Backend-related settings for the Web Designer component.

Required: Yes

url

designerSettings.server.url = 'api/designer';

onBeforeRequest()

Description: Settings for document title in the Web Designer component.

Required: Yes

onUpdate()

designerSettings.title.onUpdate = ({ name, hasUnsavedChanges }) => `${name}${hasUnsavedChanges ? ' - Has Unsaved Changes!' : ''}`

disabled

designerSettings.title.disabled = false;

Description: Preview settings for the document in the Web Designer component.

Required: Yes

canPreview

openViewer()

designerSettings.preview.openViewer = function(options) {
   // ... create viewer and open report
};

Description: RPX platform-specific settings in the Web Designer component. Must exist for the Section Reports (.rpx) to work.

Required: Yes

enabled

initTemplates

Required: Yes

expressionSyntax

designerSettings.rdlx.expressionSyntax = 'rdl';

msl

dashboard

expressionEditorNodesFilter()

designerSettings.rdlx.expressionEditorNodesFilter = (key) => {
   if (key.includes('commonValues')) return false;
   if (key.includes('aggregate.aggregateIfWithScope')) return false;
   return true;
}

toolBoxContent

designerSettings.rdlx.toolBoxContent = {
   cpl: [ 'checkbox', 'container', 'textbox' ],
   fpl: [ 'image', 'list', 'table', 'tablix', 'chart', 'bullet', 'barcode', 'formattedtext' ],
}

Description: Use Page reports to set custom templates for specific Page report items, for example, 'OverflowPlaceHolder'. It is preferable to use an RDL report or multi-section redl report for setting custom templates for all other report items, as well as for pageHeader and pageFooter. In case of Reports, set ConsumeContainerWhitespace and Page-properties: BottomMargin, LeftMargin, RightMargin, TopMargin, PageHeight, PageWidth, and ColumnSpacing.

For the rest of the report items, all properties are set, including, for example, the number of columns in the table or barcode default symbology. Note that if there is a same report item as in the previous one within a subsequent report in an array. Then, in such a case only the last template for this report item will be set. Furthermore, you can also set multiple init templates for some report items. For this, you should add a report with more than one report item of the same type. Templates with the same names will be replaced. Use the 'TemplateName' custom property of each report item to set a localized name of the template. Use the 'AllowWizard' custom property of a chart report item to allow the use of chart wizard when this report item is created. For example: ... ,"CustomProperties":[{"Name":"TemplateName","Value":"Doughnut Chart"}, {"Name":"AllowWizard","Value":"true"},...],...

Return Type: {imperialTemplates?: string[]; metricTemplates?: string[];};

Required: Optional

imperialTemplates: ['{"Name":"Report","Width":"5in","Layers":[{"Name":"default"}],"CustomProperties":[{"Name":"DisplayType","Value":"Page"},{"Name":"SizeType","Value":"Default"},{"Name":"PaperOrientation","Value":"Portrait"}],"Page":{"PageWidth":"8.5in","PageHeight":"11in","RightMargin":"1in","LeftMargin":"1in","TopMargin":"1in","BottomMargin":"1in","Columns":1,"ColumnSpacing":"0in"},"Body":{"Height":"0.25in","ReportItems":[{"Type":"textbox","Name":"TextBox1","CustomProperties":[],"CanGrow":true,"KeepTogether":true,"Style":{"PaddingLeft":"2pt","PaddingRight":"2pt","PaddingTop":"2pt","PaddingBottom":"2pt"},"Width":"5in","Height":"0.25in"}]}}'],
metricTemplates: ['{"Name":"Report","Width":"10cm","Layers":[{"Name":"default"}],"CustomProperties":[{"Name":"DisplayType","Value":"Page"},{"Name":"SizeType","Value":"Default"},{"Name":"PaperOrientation","Value":"Portrait"}],"Page":{"PageWidth":"8.5in","PageHeight":"11in","RightMargin":"1in","LeftMargin":"1in","TopMargin":"1in","BottomMargin":"1in","Columns":1,"ColumnSpacing":"0in"},"Body":{"Height":"0.75cm","ReportItems":[{"Type":"textbox","Name":"TextBox1","CustomProperties":[],"CanGrow":true,"KeepTogether":true,"Style":{"PaddingLeft":"2pt","PaddingRight":"2pt","PaddingTop":"2pt","PaddingBottom":"2pt"},"Left":"0cm","Top":"0cm","Width":"10cm","Height":"0.75cm"}]}}'],
     };

Description: Refers to customizable report item features in the Web Designer component.

Return Type: RdlxReportItemsSettings

Required: Yes

Description: Specifies additional styles to add to report item styles in the Web Designer component.

Return Type: ReportStyles[]

Required: Yes

designerSettings.rdlx.reportStyles
    {
        Bullet: [{
                id: 'c8aa4403-83ef-402b-a7da-032063cf625a',
                name: 'additionalBulletStyle1',
                content: {
                    ValueColor: 'red',
                    LabelFontColor: '=Theme.Colors!Dark1',
                    LabelFontFamily: '=Theme.Fonts!MinorFont.Family',
                    LabelFontSize: '=Theme.Fonts!MinorFont.Size',
                    LabelFontStyle: '=Theme.Fonts!MinorFont.Style',
                    TicksLineColor: '=Theme.Colors(1,0)'
                }
            },
        ],
        List: [
            {    id: '3d2c3781-4eea-4ac3-8d50-636edd9328d5',
                name: 'additionalListStyle1',
                content: {},
            },
            {    id: '5b7b4e73-22e5-42ed-99c4-62840bdde79d',
                name: 'additionalListStyle2',
                content: {
                    BackgroundColor: '=Theme.Colors!Accent1',
                    Border: {
                        Color: '=Theme.Colors(4,4)',
                        Width: '1pt',
                        Style: 'Solid',
                    }
                }
            }]
    },
    {    ChartPalette: [{
                id: 'c8aa4403-83ef-402b-a7da-0320444',
                name: 'additionalChartPalette',
                content: ['red', '=Theme.Colors!Accent2', '=Theme.Colors!Accent3', '=Theme.Colors!Accent4', '=Theme.Colors!Accent5', '=Theme.Colors!Accent6', '=Theme.Colors(5,4)', '=Theme.Colors(5,5)', '=Theme.Colors(5,6)', '=Theme.Colors(5,7)', '=Theme.Colors(5,8)', '=Theme.Colors(5,9)']
            }]
    },   
];

Description: Refers to the document name.

Return Type: string

Required: Yes

Description: Indicates whether the document has unsaved changes or not in the Web Designer component.

Return Type: boolean

Required: Yes

Description: Settings for barcodes in the Web Designer component.

symbologies

designerSettings.rdlx.reportItemsFeatures.barcode.symbologies = ['Code_128_A', 'Code_128_B', 'Code_128_C'];

Description: Settings for tables in the Web Designer component.

autoFillHeader

designerSettings.rdlx.reportItemsFeatures.table.autoFillHeader = false;

autoFillFooter

designerSettings.rdlx.reportItemsFeatures.table.autoFillFooter = true;

canMergeCellsVertically

designerSettings.rdlx.reportItemsFeatures.table.canMergeCellsVertically = false;

hideFrozenRowsColumns

designerSettings.rdlx.reportItemsFeatures.table.hideFrozenRowsColumns = true;

Description: Settings for Tablix data region in the Web Designer component.

crossAggregates

designerSettings.rdlx.reportItemsFeatures.tablix.crossAggregates = false;

autoFillCorner

designerSettings.rdlx.reportItemsFeatures.tablix.autoFillCorner = false;

canUseWizard

designerSettings.rdlx.reportItemsFeatures.tablix.canUseWizard = false;

hideFrozenRowsColumns

designerSettings.rdlx.reportItemsFeatures.tablix.hideFrozenRowsColumns = true;

Return Type: string

Required: Yes

Return Type: string

Required: Yes

Return Type: T

Required: Yes

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: BorderStyle

Required: Optional

Return Type: BorderStyle

Required: Optional

Return Type: BorderStyle

Required: Optional

Return Type: BorderStyle

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: string

Required: Optional

Return Type: { Rows: CellStyleContent[] };

Required: Yes

Return Type: { Rows: CellStyleContent[]; AlternatingExpression: string };

Required: Yes

Return Type: { Rows: CellStyleContent[] };

Required: Yes

Required: Yes

Styles

Return Type: BorderStyle

Required: Optional

Return Type: string

Required: Optional

Return Type: BorderStyle

Required: Optional

Required: Yes

Color

PaddingLeft

FontFamily

FontSize

FontStyle

FontWeight

Return Type: ReportItemStyle<BulletStyleContent>

Required: Yes

Return Type: ReportItemStyle<TextBoxStyleContent>

Required: Yes

Return Type: ReportItemStyle<ContainerStyleContent>

Required: Yes

Return Type: ReportItemStyle<TextBoxStyleContent>

Required: Yes

Return Type: ReportItemStyle<ContainerStyleContent>

Required: Yes

Return Type: ReportItemStyle<ContainerStyleContent>

Required: Yes

Return Type: ReportItemStyle<TextBoxStyleContent>

Required: Yes

Return Type: ReportItemStyle<ContainerStyleContent>

Required: Yes

Return Type: ReportItemStyle<SparklineStyleContent>

Required: Yes

Return Type: ReportItemStyle<TableStyleContent>

Required: Yes

Return Type: ReportItemStyle<TableOfContentsStyleContent>

Required: Yes

Return Type: ReportItemStyle<TableStyleContent>

Required: Yes

Return Type: ReportItemStyle<TextBoxStyleContent>

Required: Yes

Return Type: ReportItemStyle<ChartPaletteContent>

Required: Yes

Description: Refers to the host element's id where to render the Viewer.

Return Type: string

Required: Yes

Description: Refers to the application title passed by the Web Designer component.

Return Type: string

Required: Yes

Description: Information on the document to be previewed.

Required: Yes

id

content

name

temporary

preferredFormat

Description: Refers to the name of the document. If this property is not specified, the default 'Untitled' name will be used.

Return Type: string

Required: Optional

Description: Refers to the document type to create in the Web Designer component. If this property is not specified, an RDL report will be created.

Return Type: SupportedDocumentType

Required: Optional

Description: Refers to the template to use for the document.

Return Type: DocumentTemplate

Required: Optional

Description: Refers to the list of RDL Data Sets to use with the template in the Web Designer component. Note that these datasets won't work with Section Reports (.rpx).

Return Type: { id: string;, name: string;}[];

1. 1.      where
      1.  id refers to the dataset id.
      2.  name refers to the dataset name.

Required: Optional

Description: Refers to the document type in the Web Designer component.

Return Type: SupportedDocumentType

Required: Yes

Description: Refers to the document name in the Web Designer component.

Return Type: string

Required: Yes

Description: Refers to the document template in the Web Designer component.

Return Type: DocumentTemplate

Required: Optional

Description: Undefined in onBeforeCreate handler. Defined in onAfterCreate handler.

Return Type: boolean

Required: Optional

Description: Refers to the document id. If an existing report is edited, id is defined. Otherwise, if a new report is edited, id is 'null'.

Return Type: string | null

Required: Yes

Description: Refers to the document name in the Web Designer component.

Return Type: string

Required: Yes

Description: Refers to the document type in the Web Designer component.

Return Type: SupportedDocumentType

Required: Yes

Description: Refers to the document template id.

Return Type: string

Required: Optional

Description: Refers to the document template content in JSON format that can be useful in case you would like to create a non-empty new report.

Return Type: unknown

Required: Optional

Description: Refers to the template information. If it is specified for report creation, either templateInfo.id or templateinfo.content needs to be defined.

Return Type: DocumentTemplate

Required: Optional

Description: Refers to the list of RDL datasets to use with the template. Note that these datasets won't work with Section Reports (.rpx).

Return Type: {id: string; name: string;}[];

1. 1.      where
      1.  id refers to the dataset id.
      2.  name refers to the dataset name.

Required: Optional

Description: Refers to the new report name. If you do not specify the name, the report name is set to 'Untitled'.

Return Type: string

Required: Optional

Description: Refers to the report type. If not specified RDL report will be created.

Return Type: SupportedDocumentType

Required: Optional

Description: Refers to the type of document.

Return Type: SupportedDocumentType

Required: Yes

Description: If an existing document is to be overwritten on saving, the correct id should be specified explicitly.

Return Type: string

Required: Optional

Description: The correct name needs to be always specified explicitly.

Return Type: string

Required: Yes

Description: Indicates that a new document is being saved for the first time.

Return Type: boolean

Required: Yes

Description: Undefined in onBefore handler. Defined in onAfter handler.

Return Type: boolean

Required: Optional

Description: Refers to the type of document.

Return Type: SupportedDocumentType

Required: Yes

Description: Refers to the document id.

Return Type: string

Required: Yes

Description: Refers to the document name.

Return Type: string

Required: Yes

Description: Undefined in onBefore handler. Defined in onAfter handler.

Return Type: boolean

Required: Optional