TdxSpreadSheetReportDesigner Class

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

Declaration

delphi

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.

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

BiDiModeSpecifies the active bi-directional display mode.DialogsLookAndFeel | LookAndFeelProvide access to look & feel settings for the control and all built-in dialogs.OptionsLockedStateImageProvides access to display settings for a Locked View image.OptionsViewProvides access to general appearance settings.StylesProvides access to the style collection.

User Interaction-Related APIs

HistoryAllows you to enable and manage the action history.OnCommentHide | OnCommentShowAllow you to track comment visibility changes.OnHyperlinkExecuteAllows you to complement or override predefined hyperlink activation behavior.OptionsBehaviorProvides access to general spreadsheet control behavior settings.OnPageControlContextPopup | OnTableViewContextPopupAllow you to customize or disable predefined context menus.

Spreadsheet Content Management APIs

ActiveSheet | ActiveSheetAsTableProvide access to the active worksheet in the current spreadsheet document template.AddSheetAdds a new worksheet to the current spreadsheet document template.ClearAllDeletes all worksheets.DefaultCellStyleProvides access to cell style settings defined at the spreadsheet document level.DefinedNamesProvides access to the collection of defined names and formula expression references defined within the current spreadsheet document template.EvaluateExpressionEvaluates formula expressions for the specified worksheet.GetSheetByNameProvides access to a worksheet by caption in the current document template.SheetCount | VisibleSheetCountReturn the total number of worksheets and the number of currently visible worksheets in the spreadsheet document template.Sheets | VisibleSheetsProvide indexed access to visible and hidden worksheets in the current spreadsheet document template.

Template Layout Management APIs

FindSection | FindSectionByCell | GetSection | GetSectionByCellProvide access to individual template sections.RemoveSectionDeletes individual template sections.SetDetailSectionCreates detail template sections.SetGroupHeaderSection | SetGroupFooterSectionCreate header and footer template section for grouped dataset records.SetHeaderSection | SetFooterSectionCreate common header and footer sections.

Document Generation/Mail Merge-Related APIs

BuildGenerates spreadsheet documents based on the current template and bound data sources.DataBindingProvides access to data binding settings. You can use this property to bind the Spreadsheet control to one or more datasets.OptionsProvides access to spreadsheet template-related settings.

Document Template Management/Import & Export

LoadFromFile | SaveToFileImport and export spreadsheet document templates to/from a file (in any supported format).LoadFromStream | SaveToStreamImport and export spreadsheet document templates to/from a stream (in any supported format).Modified | OnModifiedChangedAllow you to track changes in a spreadsheet document template.OnGetPasswordAllows you to specify a password for a protected spreadsheet document template in code.OptionsMetadataProvides access to spreadsheet document metadata.OptionsProtection | PasswordAllow you to enforce or cancel spreadsheet document template protection (for XLSX and XLS formats only).

General-Purpose API Members

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

Other Controls

TdxSpreadSheetA Spreadsheet control.TdxSpreadSheetFormulaBarA Formula Bar control.

Implements

IcxFilterControl

Inheritance

TObject TPersistent TComponent TControl TWinControl TCustomControl TcxCustomControl TcxControl TdxCustomSpreadSheet TdxSpreadSheetReportDesigner