TdxSpreadSheetReportDesigner Class

Declaration

TdxSpreadSheetReportDesigner = class(
    TdxCustomSpreadSheet,
    IcxFilterControl
)

Remarks

The Report Designer control is a data-aware version of the Spreadsheet control. The Report Designer allows users to create reports that obtain data from a plain dataset or multiple tables that form a one-to-many (master-detail) relationship. A report template includes placeholder fields bound to dataset fields. The Report Designer populates these placeholders with data when it generates spreadsheet documents (reports).

Report Designer Example

Main API Members

The list below outlines key members of the TdxSpreadSheetReportDesigner class that allow you to manage spreadsheet documents, configure report templates, build reports as well as customize general appearance and behavior settings.

Create common header and footer template sections (SetHeaderSection and SetFooterSection).
Create detail template sections (SetDetailSection).
Create header and footer template sections for the content common to grouped dataset records (SetGroupHeaderSection and SetGroupFooterSection).
Delete template sections (RemoveSection).
Obtain specific template sections (FindSection, FindSectionByCell, GetSection, and GetSectionByCell).
Bind one or more data sources (DataBinding).
Customize report-related settings (Options).
Build and update report documents (Build).
Track document content changes (Modified and OnModifiedChanged).
Switch between bi-directional display modes (BiDiMode).
Enforce or cancel spreadsheet document protection (Password and OptionsProtection).
Specify a password for an encrypted document in code (OnGetPassword).
Customize global behavior and functionality settings (OptionsBehavior).
Manage document metadata (OptionsMetadata).
Customize the control’s appearance (OptionsView, LookAndFeel, DialogsLookAndFeel, and Styles).
Specify display settings for a Locked View image (OptionsLockedStateImage).
Configure the caption bar (PageControl).
Obtain the total number of worksheets and the number of currently visible worksheets (SheetCount and VisibleSheetCount).
Access individual worksheets in the document by their indexes (Sheets and VisibleSheets).
Manage worksheets (AddSheet and ClearAll).
Access the active worksheet (ActiveSheet and ActiveSheetAsTable).
Avoid excessive redraw operations during batch data and appearance changes (BeginUpdate and EndUpdate).
Customize the default cell style (DefaultCellStyle).
Manage Undo and Redo action lists (History).
Access a worksheet by its caption (GetSheetByName).
Track comment visibility changes (OnCommentHide and OnCommentShow).
Customize or disable built-in context menus (OnPageControlContextPopup and OnTableViewContextPopup).
Manage defined names and formula expression references (DefinedNames).
Evaluate custom expressions (EvaluateExpression).
Complement or override the default hyperlink execution routines (OnHyperlinkExecute).
Import spreadsheet documents from a file or stream (LoadFromFile and LoadFromStream).
Export data to a file or stream as a spreadsheet document (SaveToFile and SaveToStream).