devexpress-reporting/designer/controls/metadata/properties/scriptMetadata.js

DevExpress Reporting provides the capability to develop a reporting application to create and customize reports.

/**
* DevExpress HTML/JS Reporting (designer\controls\metadata\properties\scriptMetadata.js)
* Version:  24.2.6
* Build date: Mar 18, 2025
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
* License: https://www.devexpress.com/Support/EULAs/universal.xml
*/
import { editorTemplates } from '@devexpress/analytics-core/analytics-widgets';
import { designerEditorTemplates } from '../../../widgets/editorTemplates';
export const afterPrint = { propertyName: 'onAfterPrint', modelName: '@OnAfterPrint', displayName: 'After Print', localizationId: 'DevExpress.XtraReports.UI.XRControlEvents.OnAfterPrint', editor: designerEditorTemplates.getEditor('scriptsBox') };
export const beforePrint = { propertyName: 'onBeforePrint', modelName: '@OnBeforePrint', displayName: 'Before Print', localizationId: 'DevExpress.XtraReports.UI.XRControlEvents.OnBeforePrint', editor: designerEditorTemplates.getEditor('scriptsBox') };
export const sizeChanged = { propertyName: 'onSizeChanged', modelName: '@OnSizeChanged', displayName: 'Size Changed', localizationId: 'DevExpress.XtraReports.UI.XRControlEvents.OnSizeChanged', editor: designerEditorTemplates.getEditor('scriptsBox') };
export const evaluateBinding = { propertyName: 'onEvaluateBinding', modelName: '@OnEvaluateBinding', displayName: 'Evaluate Binding', localizationId: 'DevExpress.XtraReports.UI.XRControlEvents.OnEvaluateBinding', editor: designerEditorTemplates.getEditor('scriptsBox') };
export const truncatedControlEventsSerializationInfo = [
    afterPrint, beforePrint,
    { propertyName: 'onLocationChanged', modelName: '@OnLocationChanged', displayName: 'Location Changed', localizationId: 'DevExpress.XtraReports.UI.XRControlEvents.OnLocationChanged', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onParentChanged', modelName: '@OnParentChanged', displayName: 'Parent Changed', localizationId: 'DevExpress.XtraReports.UI.XRControlEvents.OnParentChanged', editor: designerEditorTemplates.getEditor('scriptsBox') },
];
export const truncatedControlScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.XRPageBreak.Scripts', info: truncatedControlEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
const commonEventsSerializationInfo = truncatedControlEventsSerializationInfo.concat([sizeChanged,
    { propertyName: 'onDraw', modelName: '@OnDraw', displayName: 'Draw', localizationId: 'DevExpress.XtraReports.UI.XRControlEvents.OnDraw', editor: designerEditorTemplates.getEditor('scriptsBox') },
    evaluateBinding,
    { propertyName: 'onPrintOnPage', modelName: '@OnPrintOnPage', displayName: 'Print on Page', localizationId: 'DevExpress.XtraReports.UI.XRControlEvents.OnPrintOnPage', editor: designerEditorTemplates.getEditor('scriptsBox') }
]);
export const commonScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.XRControl.Scripts', info: commonEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
const controlEventsSerializationInfo = commonEventsSerializationInfo.concat([
    { propertyName: 'onHtmlItemCreated', modelName: '@OnHtmlItemCreated', displayName: 'Html Item Created', localizationId: 'DevExpress.XtraReports.UI.XRControlEvents.OnHtmlItemCreated', editor: designerEditorTemplates.getEditor('scriptsBox') }
]);
export const controlScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.XRLine.Scripts', info: controlEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
const textControlEventsSerializationInfo = controlEventsSerializationInfo.concat([
    { propertyName: 'onTextChanged', modelName: '@OnTextChanged', displayName: 'Text Changed', localizationId: 'DevExpress.XtraReports.UI.XRControlEvents.OnTextChanged', editor: designerEditorTemplates.getEditor('scriptsBox') }
]);
export const textControlScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.XRLabel.Scripts', info: textControlEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
const labelEventsSerializationInfo = textControlEventsSerializationInfo.concat([
    { propertyName: 'onSummaryCalculated', modelName: '@OnSummaryCalculated', displayName: 'Summary Calculated', localizationId: 'DevExpress.XtraReports.UI.XRLabelScripts.OnSummaryCalculated', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onSummaryGetResult', modelName: '@OnSummaryGetResult', displayName: 'Summary Get Result', localizationId: 'DevExpress.XtraReports.UI.XRLabelScripts.OnSummaryGetResult', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onSummaryReset', modelName: '@OnSummaryReset', displayName: 'Summary Reset', localizationId: 'DevExpress.XtraReports.UI.XRLabelScripts.OnSummaryReset', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onSummaryRowChanged', modelName: '@OnSummaryRowChanged', displayName: 'Summary Row Changed', localizationId: 'DevExpress.XtraReports.UI.XRLabelScripts.OnSummaryRowChanged', editor: designerEditorTemplates.getEditor('scriptsBox') }
]);
export const labelScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.XRLabel.Scripts', info: labelEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
const specificChartEventsSerializationInfo = [
    { propertyName: 'onCustomDrawSeries', modelName: '@OnCustomDrawSeries', displayName: 'Custom Draw a Series', localizationId: 'DevExpress.XtraReports.UI.XRChartScripts.OnCustomDrawSeries', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomDrawSeriesPoint', modelName: '@OnCustomDrawSeriesPoint', displayName: 'Custom Draw a Series Point', localizationId: 'DevExpress.XtraReports.UI.XRChartScripts.OnCustomDrawSeriesPoint', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomDrawAxisLabel', modelName: '@OnCustomDrawAxisLabel', displayName: 'Custom Draw an Axis Label', localizationId: 'DevExpress.XtraReports.UI.XRChartScripts.OnCustomDrawAxisLabel', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomPaint', modelName: '@OnCustomPaint', displayName: 'Custom Paint', localizationId: 'DevExpress.XtraReports.UI.XRChartScripts.OnCustomPaint', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onBoundDataChanged', modelName: '@OnBoundDataChanged', displayName: 'Bound Data Changed', localizationId: 'DevExpress.XtraReports.UI.XRChartScripts.OnBoundDataChanged', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onPieSeriesPointExploded', modelName: '@OnPieSeriesPointExploded', displayName: 'Pie Series Point Exploded', localizationId: 'DevExpress.XtraReports.UI.XRChartScripts.OnPieSeriesPointExploded', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onAxisScaleChanged', modelName: '@OnAxisScaleChanged', displayName: 'Axis Scale Changed', localizationId: 'DevExpress.XtraReports.UI.XRChartScripts.OnAxisScaleChanged', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onSmallChartTextShowing', modelName: '@OnSmallChartTextShowing', displayName: 'Small Chart Text Showing', localizationId: 'DevExpress.XtraReports.UI.XRChartScripts.OnSmallChartTextShowing', editor: designerEditorTemplates.getEditor('scriptsBox') }
], chartEventsSerializationInfo = controlEventsSerializationInfo.concat(specificChartEventsSerializationInfo);
export const chartScripts = { propertyName: 'scripts', modelName: 'Scripts', info: chartEventsSerializationInfo, displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.XRChart.Scripts', editor: editorTemplates.getEditor('objecteditor') };
const specificPivotEventsSerializationInfo = [
    { propertyName: 'onCustomCellDisplayText', modelName: '@OnCustomCellDisplayText', displayName: 'Custom Cell Display Text', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnCustomCellDisplayText', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomCellValue', modelName: '@OnCustomCellValue', displayName: 'Custom Cell Value', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnCustomCellValue', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomColumnWidth', modelName: '@OnCustomColumnWidth', displayName: 'Custom Column Width', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnCustomColumnWidth', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomFieldSort', modelName: '@OnCustomFieldSort', displayName: 'Custom Field Sort', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnCustomFieldSort', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomFieldValueCells', modelName: '@OnCustomFieldValueCells', displayName: 'Custom Field Value Cells', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnCustomFieldValueCells', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomGroupInterval', modelName: '@OnCustomGroupInterval', displayName: 'Custom Group Interval', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnCustomGroupInterval', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomRowHeight', modelName: '@OnCustomRowHeight', displayName: 'Custom Row Height', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnCustomRowHeight', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomSummary', modelName: '@OnCustomSummary', displayName: 'Custom Summary', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnCustomSummary', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onCustomUnboundFieldData', modelName: '@OnCustomUnboundFieldData', displayName: 'Custom Unbound Field Data', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnCustomUnboundFieldData', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onFieldValueDisplayText', modelName: '@OnFieldValueDisplayText', displayName: 'Field Value Display Text', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnFieldValueDisplayText', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onPrefilterCriteriaChanged', modelName: '@OnPrefilterCriteriaChanged', displayName: 'Prefilter Criteria Changed', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnPrefilterCriteriaChanged', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onPrintCell', modelName: '@OnPrintCell', displayName: 'Print Cell', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnPrintCell', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onPrintFieldValue', modelName: '@OnPrintFieldValue', displayName: 'Print Field Value', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnPrintFieldValue', editor: designerEditorTemplates.getEditor('scriptsBox') },
    { propertyName: 'onPrintHeader', modelName: '@OnPrintHeader', displayName: 'Print Header', localizationId: 'DevExpress.XtraReports.UI.XRPivotGridScripts.OnPrintHeader', editor: designerEditorTemplates.getEditor('scriptsBox') }
], pivotEventsSerializationInfo = truncatedControlEventsSerializationInfo.concat([sizeChanged], specificPivotEventsSerializationInfo);
export const pivotScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.XRPivotGrid.Scripts', info: pivotEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
export const subreportScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.SubreportBase.Scripts', info: truncatedControlEventsSerializationInfo.concat(sizeChanged), editor: editorTemplates.getEditor('objecteditor') };
export const pdfContentScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.XRPdfContent.Scripts', info: truncatedControlEventsSerializationInfo.concat(evaluateBinding), editor: editorTemplates.getEditor('objecteditor') };
const commonBandEventsSerializationInfo = [afterPrint, beforePrint];
export const commonBandScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.Band.Scripts', info: commonBandEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
const onBandLevelChanged = { propertyName: 'onBandLevelChanged', modelName: '@OnBandLevelChanged', displayName: 'Band Level Changed', localizationId: 'DevExpress.XtraReports.UI.GroupBandScripts.OnBandLevelChanged', editor: designerEditorTemplates.getEditor('scriptsBox') }, groupBandEventsSerializationInfo = commonBandEventsSerializationInfo.concat([onBandLevelChanged]);
export const groupBandScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.GroupHeaderBand.Scripts', info: groupBandEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
const onSortingSummaryGetResult = { propertyName: 'onSortingSummaryGetResult', modelName: '@OnSortingSummaryGetResult', displayName: 'Sorting Summary Get Result', localizationId: 'DevExpress.XtraReports.UI.GroupHeaderBandScripts.OnSortingSummaryGetResult', editor: designerEditorTemplates.getEditor('scriptsBox') }, onSortingSummaryReset = { propertyName: 'onSortingSummaryReset', modelName: '@OnSortingSummaryReset', displayName: 'Sorting Summary Reset', localizationId: 'DevExpress.XtraReports.UI.GroupHeaderBandScripts.OnSortingSummaryReset', editor: designerEditorTemplates.getEditor('scriptsBox') }, onSortingSummaryRowChanged = { propertyName: 'onSortingSummaryRowChanged', modelName: '@OnSortingSummaryRowChanged', displayName: 'Sorting Summary RowChanged', localizationId: 'DevExpress.XtraReports.UI.GroupHeaderBandScripts.OnSortingSummaryRowChanged', editor: designerEditorTemplates.getEditor('scriptsBox') }, groupHeaderBandEventsSerializationInfo = groupBandEventsSerializationInfo.concat([onSortingSummaryGetResult, onSortingSummaryReset, onSortingSummaryRowChanged]);
export const groupHeaderBandScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.GroupHeaderBand.Scripts', info: groupHeaderBandEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
const onBandHeightChanged = { propertyName: 'onBandHeightChanged', modelName: '@OnBandHeightChanged', displayName: "Band's Height Changed", localizationId: 'DevExpress.XtraReports.UI.XtraReportScripts.OnBandHeightChanged', editor: designerEditorTemplates.getEditor('scriptsBox') }, onDataSourceRowChanged = { propertyName: 'onDataSourceRowChanged', modelName: '@OnDataSourceRowChanged', displayName: "Data Source's Row Changed", localizationId: 'DevExpress.XtraReports.UI.XtraReportBase.DataSource', editor: designerEditorTemplates.getEditor('scriptsBox') }, onDataSourceDemanded = { propertyName: 'onDataSourceDemanded', modelName: '@OnDataSourceDemanded', displayName: 'Data Source Demanded', localizationId: 'DevExpress.XtraReports.UI.XtraReportScripts.OnDataSourceDemanded', editor: designerEditorTemplates.getEditor('scriptsBox') }, detailReportBandEventsSerializationInfo = commonBandEventsSerializationInfo.concat([onBandHeightChanged, onDataSourceRowChanged, onDataSourceDemanded]);
export const detailReportBandScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.DetailReportBand.Scripts', info: detailReportBandEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
const onFillEmptySpace = { propertyName: 'onFillEmptySpace', modelName: '@OnFillEmptySpace', displayName: 'Fill Empty Space', localizationId: 'DevExpress.XtraReports.UI.XtraReportScripts.OnFillEmptySpace', editor: designerEditorTemplates.getEditor('scriptsBox') }, onPrintProgress = { propertyName: 'onPrintProgress', modelName: '@OnPrintProgress', displayName: 'Print Progress', localizationId: 'DevExpress.XtraReports.UI.XtraReportScripts.OnPrintProgress', editor: designerEditorTemplates.getEditor('scriptsBox') }, onParametersRequestBeforeShow = { propertyName: 'onParametersRequestBeforeShow', modelName: '@OnParametersRequestBeforeShow', displayName: 'Parameters Request Before Show', localizationId: 'DevExpress.XtraReports.UI.XtraReportScripts.OnParametersRequestBeforeShow', editor: designerEditorTemplates.getEditor('scriptsBox') }, onParametersRequestValueChanged = { propertyName: 'onParametersRequestValueChanged', modelName: '@OnParametersRequestValueChanged', displayName: 'Parameters Changed', localizationId: 'DevExpress.XtraReports.UI.XtraReportScripts.OnParametersRequestValueChanged', editor: designerEditorTemplates.getEditor('scriptsBox') }, onParametersRequestSubmit = { propertyName: 'onParametersRequestSubmit', modelName: '@OnParametersRequestSubmit', displayName: 'Parameters Submitted', localizationId: 'DevExpress.XtraReports.UI.XtraReportScripts.OnParametersRequestSubmit', editor: designerEditorTemplates.getEditor('scriptsBox') }, reportEventsSerializationInfo = detailReportBandEventsSerializationInfo.concat([
    onFillEmptySpace, onPrintProgress, onParametersRequestBeforeShow, onParametersRequestValueChanged, onParametersRequestSubmit
]);
export const reportScripts = { propertyName: 'scripts', modelName: 'Scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.XtraReport.Scripts', info: reportEventsSerializationInfo, editor: editorTemplates.getEditor('objecteditor') };
export const allScripts = {
    propertyName: 'scripts', displayName: 'Scripts', localizationId: 'DevExpress.XtraReports.UI.XRControl.Scripts', info: labelEventsSerializationInfo.concat(specificChartEventsSerializationInfo, specificPivotEventsSerializationInfo, [
        onBandLevelChanged, onSortingSummaryGetResult, onSortingSummaryReset, onSortingSummaryRowChanged, onBandHeightChanged, onDataSourceRowChanged, onDataSourceDemanded,
        onFillEmptySpace, onPrintProgress, onParametersRequestBeforeShow, onParametersRequestValueChanged, onParametersRequestSubmit
    ]), editor: editorTemplates.getEditor('objecteditor')
};