TdxSpreadSheetReportDesigner Class

A data-aware Spreadsheet control for document generation (Mail Merge).

Declaration

TdxSpreadSheetReportDesigner = class(
    TdxCustomSpreadSheet,
    IcxFilterControl
)

Remarks

The TdxSpreadSheetReportDesigner control is a data-aware version of the Spreadsheet control. You can use this control to generate spreadsheet documents based on templates bound to dataset fields.

VCL Spreadsheet: A Mail Merge Example

Tip

The TdxSpreadSheetReportDesigner control is designed for simple usage scenarios. For advanced report generation and Business Intelligence/data analysis, we recommend that you use our ExpressReports and ExpressDashboards Suites (available as part of the VCL Subscription +). These advanced solutions include both the powerful report generator and customizable print preview, BI dashboard designer and viewer available both at design- and runtime, smart/AI functions, non-GUI/service-based document generation, and much more.

Main API Members

The list below outlines key members of the TdxSpreadSheetReportDesigner class. You can use these members to manage spreadsheet document templates, generate documents and customize appearance and behavior settings.

Appearance Settings

BiDiMode: Specifies the active bi-directional display mode.
DialogsLookAndFeel | LookAndFeel: Provide access to look & feel settings for the control and all built-in dialogs.
OptionsLockedStateImage: Provides access to display settings for a Locked View image.
OptionsView: Provides access to general appearance settings.
Styles: Provides access to the style collection.

History: Allows you to enable and manage the action history.
OnCommentHide | OnCommentShow: Allow you to track comment visibility changes.
OnHyperlinkExecute: Allows you to complement or override predefined hyperlink activation behavior.
OptionsBehavior: Provides access to general spreadsheet control behavior settings.
OnPageControlContextPopup | OnTableViewContextPopup: Allow you to customize or disable predefined context menus.

Spreadsheet Content Management APIs

ActiveSheet | ActiveSheetAsTable: Provide access to the active worksheet in the current spreadsheet document template.
AddSheet: Adds a new worksheet to the current spreadsheet document template.
ClearAll: Deletes all worksheets.
DefaultCellStyle: Provides access to cell style settings defined at the spreadsheet document level.
DefinedNames: Provides access to the collection of defined names and formula expression references defined within the current spreadsheet document template.
EvaluateExpression: Evaluates formula expressions for the specified worksheet.
GetSheetByName: Provides access to a worksheet by caption in the current document template.
SheetCount | VisibleSheetCount: Return the total number of worksheets and the number of currently visible worksheets in the spreadsheet document template.
Sheets | VisibleSheets: Provide indexed access to visible and hidden worksheets in the current spreadsheet document template.

Template Layout Management APIs

FindSection | FindSectionByCell | GetSection | GetSectionByCell: Provide access to individual template sections.
RemoveSection: Deletes individual template sections.
SetDetailSection: Creates detail template sections.
SetGroupHeaderSection | SetGroupFooterSection: Create header and footer template section for grouped dataset records.
SetHeaderSection | SetFooterSection: Create common header and footer sections.

Build: Generates spreadsheet documents based on the current template and bound data sources.
DataBinding: Provides access to data binding settings. You can use this property to bind the Spreadsheet control to one or more datasets.
Options: Provides access to spreadsheet template-related settings.

Document Template Management/Import & Export

LoadFromFile | SaveToFile: Import and export spreadsheet document templates to/from a file (in any supported format).
LoadFromStream | SaveToStream: Import and export spreadsheet document templates to/from a stream (in any supported format).
Modified | OnModifiedChanged: Allow you to track changes in a spreadsheet document template.
OnGetPassword: Allows you to specify a password for a protected spreadsheet document template in code.
OptionsMetadata: Provides access to spreadsheet document metadata.
OptionsProtection | Password: Allow you to enforce or cancel spreadsheet document template protection (for XLSX and XLS formats only).

General-Purpose API Members

BeginUpdate | EndUpdate | CancelUpdate: Allow you to avoid excessive redraw operations during batch data, setting, and appearance changes.
PageControl: Provides access to page control/caption bar settings for the Spreadsheet control.