This topic describes Designer Options Object Properties. For more information see Web Designer API.
serverApi
Type: DesignerServerApi
reportInfo (optional)
Description: If report id is specified, the corresponding report will be opened in designer when designer application is rendered.
Type:
{ id?: string }
Example:
designerOptions.reportInfo.id = 'MyReport.rdlx';
locale (optional)
Description: If the locale value is not specified explicitly here, the locale corresponding to the browser preferences is used.
Type: 'en' | 'zh' | 'ja'
Example:
designerOptions.locale = 'zh';
units (optional)
Description: If measurement units are not specified explicitly here, they are identified depending on locale.
Type: 'in' | 'cm'
Example:
designerOptions.units = 'cm';
reportItems (optional)
Description: It is possible to limit and/or reorder available report items. Specify comma-separated report items keys from following: TextBox, CheckBox, Container, Line, Shape, TableOfContents, Image, InputField, List, Table, Tablix, Chart, Bullet, Barcode, FormattedText, Sparkline, Subreport, and OverflowPlaceholder.
Type: string
Example:
designerOptions.reportItems = 'TextBox,CheckBox,Table,Chart,Image';
lockLayout
Description: By default lockLayout is disabled. When lockLayout is enabled, it is only possible to modify properties of existing report items. That is, adding a new report item or deleting an existing one is not possible as well as other operations that modify report layout structure.
Type: boolean
Example:
designerOptions.lockLayout = true;
restoreUnsavedReport
Description: By default restoreUnsavedReport is enabled. In this case the last unsaved report can be restored if browser tab or browser itself gets accidentally closed. When restoreUnsavedReport is disabled, the aforementioned functionality is not available.
Type: boolean
Example:
designerOptions.restoreUnsavedReport = false;
saveButton
Description: Specifies whether Save button needs to be shown. Save button is not visible by default.
Type:
{ visible: boolean }
Example:
designerOptions.saveButton.visible = true;
saveAsButton
Description: Specifies whether Save As button needs to be shown. Save As button is not visible by default.
Type:
{ visible: boolean }
Example:
designerOptions.saveAsButton.visible= true;
reportExplorer
Description: Specifies whether Report Explorer button needs to be shown. Report Explorer button is visible by default.
Type:
{ visible: boolean }
Example:
designerOptions.reportExplorer.visible= false;
groupEditor
Description: Specifies whether Group Editor button needs to be shown. Group Editor button is visible by default.
Type:
{ visible: boolean }
Example:
designerOptions.groupEditor.visible = false;
toolBox
Description: Specifies whether left-side menu Toolbox needs to be shown. Toolbox is visible by default.
Type:
{ visible: boolean }
Example:
designerOptions.toolBox.visible = false;
insertTab
Description: Specifies whether application bar menu Insert Tab needs to be shown. Insert Tab is not visible by default. Toolbox and Insert Tab are interchangeable.
Type:
{ visible: boolean }
Example:
designerOptions.insertTab.visible = true;
propertiesTab
Description:
Type:
{
visible: boolean,
mode: 'Both' | 'Advanced' | 'Basic',
defaultMode?: 'Advanced' | 'Basic',
}
Example:
designerOptions.propertiesTab.visible = false;
designerOptions.propertiesTab.mode = 'Basic';
designerOptions.propertiesTab.defaultMode = 'Advanced';
dataTab
Description:
Type:
{
visible: boolean,
dataSources: {
visible: boolean,
},
dataSets: {
visible: boolean,
canModify: boolean,
},
parameters: {
visible: boolean,
canModify: boolean,
},
commonValues: {
visible: boolean,
},
}
Example:
designerOptions.dataTab.visible = false;
designerOptions.dataTab.dataSources.visible = false;
designerOptions.dataTab.dataSets.visible = false;
designerOptions.dataTab.dataSets.canModify = true;
designerOptions.dataTab.parameters.visible = false;
designerOptions.dataTab.parameters.canModify = false;
designerOptions.dataTab.dataSources.visible = false;
gridSize
Description:
Example:
designerOptions.gridSize.visible = false;
designerOptions.gridSize.value = '0.75cm'; /* or */ designerOptions.gridSize.value = '0.5in';
showGrid
Description:
Example:
designerOptions.showGrid.visible = false;
designerOptions.showGrid.value = false;
canEditDataSource
Description: Indicates whether a data source can be edited.
Type: boolean
Example:
@param options CanEditDataSourceOptions object
canEditDataSet
Description: Indicates whether a data set can be edited.
Type: boolean
Example:
@param options CanEditDataSetOptions object
canAddDataSetForDataSource
Description: Returns a data set initialized for the specified data source.
Type: boolean
Example:
@param options InitDataSetForDataSourceOptions object
initDataSetForDataSource
Description: Returns properties available for the specified data set.
Type: Dataset
Example:
@param options GetDataSetPropertiesOptions object
getDataSetSchema
Description: Gets schema for the specified data set.
Example:
@param option GetDataSetSchemaOptions object getDataSetSchema: (options: GetDataSetSchemaOptions) => Promise;
fonts
Description: Specifies the list of fonts displayed in font properties drop-downs all over Designer. If fonts are not specified explicitly here, the default list of fonts is used.
Type: Array<string>
Example:
designerOptions.fonts = ['Arial', 'Courier New', 'Times New Roman'];
openViewer
Description: You can plug-in Report Viewer component by providing openViewer() function implementation to DesignerOptions object. When openViewer() is implemented and passed to DesignerOptions, Preview button appears in Designer application bar.
Example:
designerOptions.openViewer = openViewerImpl;
openFileView
Description: You can plug-in File View component by providing openFileView() function implementation to DesignerOptions object. When openFileView() is implemented and passed to DesignerOptions, File tab appears in Designer application bar.
Example:
designerOptions.openFileView = openFileViewImpl;
onSave
Description: You can specify behavior for Save Report scenario by providing onSave() function implementation to DesignerOptions object.
Example:
designerOptions.onSave = onSaveImpl;
onSaveAs
Description: You can specify behavior for Save Report As scenario by providing onSaveAs() function implementation to DesignerOptions object.
Example:
designerOptions.onSaveAs = onSaveImpl;
onOpen
Description: You can specify behavior for Open Report scenario by providing onOpen() function implementation to DesignerOptions object.
Example:
designerOptions.onOpen = onOpenImpl;
openDataSourceEditor
Description: You can specify behavior for Add/Edit Data Source scenario by providing openDataSourceEditor() function implementation to DesignerOptions object.
Example:
designerOptions.openDataSourceEditor = openDataSourceEditorImpl;
openButton
Description: Specifies whether Open button needs to be shown. Open button is not visible by default.
Type: { visible: boolean }
Example:
designerOptions.openButton.visible = true;
dataSetPicker
Example:
designerOptions.dataSetPicker.mode = 'Panel';
designerOptions.dataSetPicker.open = openDataSetPickerImpl;
designerOptions.dataSetPicker.close = closeDataSetPickerImpl;
reportItemsFeatures
Description: Overrides the default symbology used for newly-created barcodes. By default new barcodes are created with QR Code symbology.
Type: BarcodeSymbology
Example:
designerOptions.reportItemsFeatures.barcode.defaultSymbology = 'Code_128_A';symbologies
Description: Limits the list of barcode symbologies available for creation. By default all barcode symbologies supported by ActiveReports are available..
Type: Array<BarcodeSymbology>
Example:
designerOptions.reportItemsFeatures.barcode.symbologies = ['Code_128_A', 'Code_128_B', 'Code_128_C']
Description: Specifies whether Table Header needs to be auto-filled when a field is dropped to Table Details. For example, if ProductName field is dropped to Details, Product Name value is set to Header. By default this feature is enabled.
Type: Boolean
Example:
designerOptions.reportItemsFeatures.table.autoFillHeader = false;autoFillFooter
Description: Specifies whether Table Footer needs to be auto-filled when a field is dropped to Table Details. For example, if ProductName field is dropped to Details, =Count([ProductName]) value is set to Footer. By default this feature is disabled.
Type: Boolean
Example:
designerOptions.reportItemsFeatures.table.autoFillFooter = true;canMergeCellsVertically
Description: Specifies whether vertical merge of cells is enabled within Table Header, Details, and Footer. By default this feature is enabled.
Type: Boolean
Example:
designerOptions.reportItemsFeatures.table.canMergeCellsVertically = false;
Description: Specifies whether Tablix Corner Cell needs to be auto-filled when a field is dropped to Tablix Row Group Cell. For example, if ProductName field is dropped to Row Group Cell, Product Name value is set to Corner Cell. By default this feature is enabled.
Type: Boolean
Example:
designerOptions.reportItemsFeatures.tablix.autoFillCorner = false;canUseWizard
Description: Specifies whether Tablix Wizard is available for creating or editing Tablix. By default this feature is enabled.
Type: Boolean
Example:
designerOptions.reportItemsFeatures.tablix.canUseWizard = false;