TdxCustomSpreadSheet Members
The base class for Spreadsheet and Report Designer controls.Constructors
Name | Description |
---|---|
Create(TComponent) | Inherited from TComponent. |
CreateParented(HWND) | Inherited from TWinControl. |
Properties
Name | Description |
---|---|
Action | Inherited from TControl. |
ActiveCanvas | Provides access to the control’s GDI-based canvas. Inherited from TcxControl. |
ActiveSheet | Provides access to a generic worksheet object corresponding to the currently active sheet. |
ActiveSheetAsTable | Provides access to the Table View worksheet displayed by a Spreadsheet or Report Designer. |
ActiveSheetIndex | Specifies a zero-based index of the currently active worksheet. |
Align | Inherited from TControl. |
AlignDisabled | Inherited from TWinControl. |
AlignWithMargins | Inherited from TControl. |
Anchors | Inherited from TControl. |
AutoSize | Inherited from TControl. |
BevelEdges | Inherited from TWinControl. |
BevelInner | Inherited from TWinControl. |
BevelKind | Inherited from TWinControl. |
BevelOuter | Inherited from TWinControl. |
BevelWidth | Inherited from TWinControl. |
BiDiMode | Specifies the control’s content bidirectional display mode. |
BorderSize protected | Inherited from TcxControl. |
BorderStyle protected | Specifies the control’s border style. Inherited from TcxControl. |
BorderWidth | Inherited from TWinControl. |
Bounds | Returns the control’s boundaries. Inherited from TcxControl. |
BoundsRect | Inherited from TControl. |
Brush | Inherited from TWinControl. |
Canvas | Provides access to the control’s GDI-based canvas. Inherited from TcxControl. |
Caption | Inherited from TControl. |
CellStyles | Stores all cell styles used in a workbook. |
ClientBounds | Returns the control’s client area. Inherited from TcxControl. |
ClientHeight | Inherited from TControl. |
ClientOrigin | Inherited from TControl. |
ClientRect | Inherited from TControl. |
ClientWidth | Inherited from TControl. |
Color | Inherited from TControl. |
ComObject | Inherited from TComponent. |
ComponentCount | Inherited from TComponent. |
ComponentIndex | Inherited from TComponent. |
Components | Inherited from TComponent. |
ComponentState | Inherited from TComponent. |
ComponentStyle | Inherited from TComponent. |
Constraints | Inherited from TControl. |
ControlCount | Inherited from TWinControl. |
Controls | Inherited from TWinControl. |
ControlState | Inherited from TControl. |
ControlStyle | Inherited from TControl. |
Ctl3D | Inherited from TWinControl. |
CurrentPPI | Inherited from TControl. |
Cursor | Inherited from TControl. |
CustomHint | Inherited from TControl. |
DefaultCellStyle | Provides access to spreadsheet document-wide cell appearance settings. |
DefinedNames | Provides access to the defined name collection within a workbook. |
DesignInfo | Inherited from TComponent. |
DialogsLookAndFeel | Specifies the look and feel of all dialogs displayed by the Spreadsheet and Report Designer controls. |
DockClientCount | Inherited from TWinControl. |
DockClients | Inherited from TWinControl. |
DockManager | Inherited from TWinControl. |
DockOrientation | Inherited from TControl. |
DockSite | Inherited from TWinControl. |
DoubleBuffered | Inherited from TWinControl. |
DragAndDropObject | Inherited from TcxControl. |
DragAndDropObjectClass | Inherited from TcxControl. |
DragAndDropState | Inherited from TcxControl. |
DragCursor | Inherited from TControl. |
DragKind | Inherited from TControl. |
DragMode | Inherited from TControl. |
Enabled | Inherited from TControl. |
ExplicitHeight | Inherited from TControl. |
ExplicitLeft | Inherited from TControl. |
ExplicitTop | Inherited from TControl. |
ExplicitWidth | Inherited from TControl. |
ExternalLinks | |
Floating | Inherited from TControl. |
FloatingDockSiteClass | Inherited from TControl. |
FocusOnClick protected | Specifies if clicking the control focuses it. Inherited from TcxControl. |
Font | Inherited from TControl. |
FormulaController | Provides access to the formula controller. |
Handle | Inherited from TWinControl. |
Height | Inherited from TControl. |
HelpContext | Inherited from TControl. |
HelpKeyword | Inherited from TControl. |
HelpType | Inherited from TControl. |
Hint | Specifies a hint message for the control. Inherited from TcxControl. |
History | Provides access to the history of undo/redo actions performed within the Spreadsheet or Report Designer control. |
HostDockSite | Inherited from TControl. |
HScrollBar protected | Inherited from TcxControl. |
HScrollBarVisible protected | Inherited from TcxControl. |
ImeMode | Inherited from TWinControl. |
ImeName | Inherited from TWinControl. |
IsDesigning | Identifies if the control is being modified by the form designer. Inherited from TcxControl. |
IsDestroying | Identifies if the control is about to be destroyed. Inherited from TcxCustomControl. |
IsDrawingLocked | Inherited from TWinControl. |
IsFocused | Identifies if the control has focus. Inherited from TcxControl. |
IsLoading | Identifies if the control is being loaded. Inherited from TcxControl. |
Keys protected | Inherited from TcxControl. |
Left | Inherited from TControl. |
LookAndFeel | Provides access to the control’s look & feel settings. Inherited from TcxControl. |
LookAndFeelPainter protected | Inherited from TcxControl. |
LRDockWidth | Inherited from TControl. |
Margins | Inherited from TControl. |
Modified | Specifies whether the control treats a loaded document as modified. |
MouseCapture | Inherited from TControl. |
MouseCaptureObject | Provides access to the dragged object during a drag-and-drop operation. Inherited from TcxControl. |
MouseDownPos | Specifies the mouse pointer position when an OnMouseDown event occurs. Inherited from TcxControl. |
MouseInClient | Inherited from TWinControl. |
Name | Inherited from TComponent. |
Observers | Inherited from TComponent. |
OptionsBehavior | Specifies the global behavior and functionality settings applied to the Spreadsheet and Report Designer. |
OptionsLockedStateImage | Specifies display settings for a “Locked View“ image. |
OptionsMetadata | Provides access to the document’s metadata. |
OptionsProtection | Specifies the spreadsheet document structure protection options. |
OptionsView | Specifies the global appearance and functionality settings applied to the Spreadsheet or Report Designer control. |
Owner | Inherited from TComponent. |
Padding | Inherited from TWinControl. |
PageControl | Provides access to the caption bar settings in the Spreadsheet or Report Designer controls. |
Parent | Inherited from TControl. |
ParentBackground protected | Inherited from TcxControl. |
ParentBiDiMode | Inherited from TControl. |
ParentColor | Inherited from TControl. |
ParentCtl3D | Inherited from TWinControl. |
ParentCustomHint | Inherited from TControl. |
ParentDoubleBuffered | Inherited from TWinControl. |
ParentFont | Inherited from TControl. |
ParentShowHint | Inherited from TControl. |
ParentWindow | Inherited from TWinControl. |
Password | Specifies the password used to encrypt and decrypt spreadsheet documents. |
PixelsPerInch | Inherited from TWinControl. |
PopupMenu protected | Specifies the popup menu associated with the control. Inherited from TcxControl. |
RaiseOnNonMainThreadUsage | Inherited from TControl. |
RedrawDisabled | Inherited from TWinControl. |
ScaleFactor | Inherited from TControl. |
ScrollBars protected | Inherited from TcxControl. |
SheetCount | Returns the total number of sheets within a workbook. |
Sheets | Provides zero-based indexed access to individual sheets within the currently active spreadsheet document. |
ShowHint | Inherited from TControl. |
Showing | Inherited from TWinControl. |
StyleElements | Inherited from TControl. |
StyleName | Inherited from TControl. |
Styles | Provides access to style settings for the visual elements of the Spreadsheet or Report Designer control. |
TabOrder | Inherited from TWinControl. |
TabStop | Inherited from TcxControl. |
Tag | Inherited from TComponent. |
TBDockHeight | Inherited from TControl. |
Text | Inherited from TControl. |
TipMode | Inherited from TWinControl. |
Top | Inherited from TControl. |
Touch | Inherited from TControl. |
Transparent protected | Specifies if the control is transparent in GDI render mode. Inherited from TcxControl. |
UndockHeight | Inherited from TControl. |
UndockWidth | Inherited from TControl. |
UseDockManager | Inherited from TWinControl. |
VCLComObject | Inherited from TComponent. |
Visible | Inherited from TControl. |
VisibleDockClientCount | Inherited from TWinControl. |
VisibleSheetCount | Returns the number of non-hidden sheets within a workbook. |
VisibleSheets | Provides zero-based indexed access to the list of non-hidden sheets within a workbook. |
VScrollBar protected | Inherited from TcxControl. |
VScrollBarVisible protected | Inherited from TcxControl. |
Width | Inherited from TControl. |
WindowProc | Inherited from TControl. |
Methods
Events
Name | Description |
---|---|
OnActiveCellChanging protected | Enables you to respond to moving focus to a specific cell (making it active). |
OnActiveSheetChanged protected | Occurs after activating another worksheet within the Spreadsheet control. |
OnAlignInsertBefore | Inherited from TWinControl. |
OnAlignPosition | Inherited from TWinControl. |
OnCanResize | Inherited from TControl. |
OnClick | Inherited from TControl. |
OnCommentHide protected | Notifies that a comment container has been automatically hidden. |
OnCommentShow protected | Enables you to disable automatic display for hidden comment containers. |
OnCompare protected | Enables you to implement the custom comparator for the sorting the cell data. |
OnConstrainedResize | Inherited from TControl. |
OnContextPopup | Inherited from TControl. |
OnCustomDrawTableViewCell protected | Enables you to implement a custom draw routine for cells within a Table View worksheet. |
OnCustomDrawTableViewCommonCell protected | Enables you to implement a custom draw routine for helper visual elements within a Table View worksheet. |
OnCustomDrawTableViewHeaderCell protected | Enables you to implement a custom draw routine for standard horizontal and vertical headers within a Table View worksheet. |
OnDataChanged protected | Enables you to perform specific actions after changing a cell object‘s value. |
OnDblClick | Inherited from TControl. |
OnDockDrop | Inherited from TWinControl. |
OnDockOver | Inherited from TWinControl. |
OnDragDrop | Inherited from TControl. |
OnDragOver | Inherited from TControl. |
OnEditChanged protected | Allows you to respond to cell editing within the current worksheet. |
OnEdited protected | Enables you to perform specific actions after deactivation of an in-place cell editor. |
OnEditing protected | Occurs before activation of an in-place cell editor within a worksheet. |
OnEditValueChanged protected | Allows you to respond to cell value changes made using an in-place editor. |
OnEndDock | Inherited from TControl. |
OnEndDrag | Inherited from TControl. |
OnEnter | Inherited from TWinControl. |
OnExit | Inherited from TWinControl. |
OnFocusChanged protected | Inherited from TcxControl. |
OnGesture | Inherited from TControl. |
OnGetPassword protected | Enables you to respond to the password request when an encrypted XLS, XLSX, XLT, or XLTX document is being loaded by the Spreadsheet or Report Designer control. |
OnGetSiteInfo | Inherited from TWinControl. |
OnHistoryChanged protected | Enables you to respond to moving history actions between the undo and redo lists. |
OnHyperlinkExecute protected | Allows you to perform custom actions on executing a hyperlink. |
OnInitEdit protected | Enables you to customize the behavior of an in-place cell editor within a particular worksheet. |
OnInitEditValue protected | Enables you to initialize the edit value of an in-place cell editor. |
OnKeyDown | Inherited from TWinControl. |
OnKeyPress | Inherited from TWinControl. |
OnKeyUp | Inherited from TWinControl. |
OnLayoutChanged protected | Enables you to respond to the Spreadsheet or Report Designer control layout changes. |
OnModifiedChanged protected | Enables you to track a loaded document’s modified state. |
OnMouseActivate | Inherited from TControl. |
OnMouseDown | Inherited from TControl. |
OnMouseEnter protected | Occurs when the mouse pointer enters into the control. Inherited from TcxControl. |
OnMouseLeave protected | Occurs when the mouse pointer leaves the control. Inherited from TcxControl. |
OnMouseMove | Inherited from TControl. |
OnMouseUp | Inherited from TControl. |
OnMouseWheel | Inherited from TControl. |
OnMouseWheelDown | Inherited from TControl. |
OnMouseWheelUp | Inherited from TControl. |
OnPageControlContextPopup protected | Enables you to customize, disable, or replace the built-in popup menu invoked within the caption bar area. |
OnPageControlNewTabButtonClick protected | Enables you to prevent the control from creating a new worksheet in response to a click on the “Add Sheet” button. |
OnPageControlTabDragAndDrop protected | Enables you to render certain positions invalid for worksheet tab drag-and-drop operations within the caption bar. |
OnPageControlTabEndDrag protected | Enables you to respond to a finished or cancelled drag-and-drop operation in the caption bar. |
OnPageControlTabStartDrag protected | Enables you to respond to a drag-and-drop operation start in the caption bar. |
OnPrepareLockedStateImage protected | Enables you to custom paint a “Locked View“ image. |
OnProgress protected | Enables you to track the progress of time-consuming operations, such as data import/export and report building. |
OnResize | Inherited from TControl. |
OnScroll protected | Enables you to respond to scrolling the active worksheet. |
OnSelectionChanged protected | Enables you to respond to any changes made to the worksheet content selection. |
OnStartDock | Inherited from TControl. |
OnStartDrag | Inherited from TControl. |
OnTableViewContextPopup protected | Enables you to customize, disable, or replace the built-in popup menu invoked in a worksheet. |
OnUnDock | Inherited from TWinControl. |
See Also