TdxCustomSpreadSheet Class

The base class for Spreadsheet and Report Designer controls.

Declaration

delphi

TdxCustomSpreadSheet = class(
    TcxControl,
    IcxLockedStateFontChanged,
    IcxLockedStatePaint,
    IdxDialogOwner,
    IdxSpreadSheet,
    IdxSpreadSheetCellStyleOwner,
    IdxSpreadSheetConditionalFormatting,
    IdxSkinSupport
)

Remarks

A Spreadsheet control allows you to create applications with a user experience inspired by Microsoft Excel®. In addition, you can associate a Spreadsheet control with a Formula Bar control to add extra cell view and edit options found in many popular spreadsheet applications.

Main API Members

The list below outlines key members of the TdxCustomSpreadSheet class that allow you to manage spreadsheet documents as well as customize general appearance and behavior settings.

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).

Terminal TdxCustomSpreadSheet Class Descendants

Do not use the TdxCustomSpreadSheet class directly. Use the following descendants instead:

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

Implements

IcxLockedStateFontChanged

IcxLockedStatePaint

IdxDialogOwner

IdxSpreadSheet

IdxSpreadSheetConditionalFormatting

IdxSkinSupport

Inheritance

TObject TPersistent TComponent TControl TWinControl TCustomControl TcxCustomControl TcxControl TdxCustomSpreadSheet