Back to Devexpress

dxSpreadSheetCore Unit

vcl-dxspreadsheetcore-c943945d.md

latest31.6 KB
Original Source

dxSpreadSheetCore Unit

Classes

NameDescription
EdxSpreadSheetCannotChangePartOfArrayErrorThe exception class for errors that occur on an unauthorized change of an array formula result cell range.
EdxSpreadSheetDefinedNameErrorThe exception class for defined name validation errors.
EdxSpreadSheetFormatErrorThe exception class for errors related to unsupported spreadsheet document formats.
EdxSpreadSheetInvalidPasswordErrorThe exception class for password validation errors.
EdxSpreadSheetProtectionErrorThe exception class for cell modification errors that occur in protected worksheets.
EdxSpreadSheetReaderErrorThe exception class for internal data load errors.
TdxCustomSpreadSheetThe base class for Spreadsheet and Report Designer controls.
TdxSpreadSheetCellStores cell content and custom style settings in a worksheet.
TdxSpreadSheetCellViewInfo
TdxSpreadSheetCellViewInfoList
TdxSpreadSheetConditionalFormattingA conditional formatting controller of a Table View worksheet displayed by the Spreadsheet or Report Designer control.
TdxSpreadSheetContainerThe base class for all classes that implement floating containers.
TdxSpreadSheetContainerAnchorPointA floating container object‘s anchor point.
TdxSpreadSheetContainersA collection of floating containers on a single worksheet.
TdxSpreadSheetContainerTransformA set of geometric transformations applied to the floating container object.
TdxSpreadSheetCustomCellViewInfo
TdxSpreadSheetCustomDrawingObject
TdxSpreadSheetCustomFiler
TdxSpreadSheetCustomFormatThe base class for all classes that implement spreadsheet document file formats.
TdxSpreadSheetCustomHitTestThe base class for HitTest classes that store information about the Spreadsheet and Report Designer control’s visual elements located at the test point.
TdxSpreadSheetCustomReader
TdxSpreadSheetCustomReferenceHighlighter
TdxSpreadSheetCustomViewThe base class for all View classes.
TdxSpreadSheetCustomViewOptionsThe base class for all classes that implement worksheet appearance and printing settings.
TdxSpreadSheetCustomViewPainter
TdxSpreadSheetCustomViewViewInfo
TdxSpreadSheetCustomWriter
TdxSpreadSheetDefaultCellStyleStores the style settings applied to uninitialized cells in a Table View worksheet.
TdxSpreadSheetDefinedNameA defined name in a spreadsheet document.
TdxSpreadSheetDefinedNamesA defined name collection in a spreadsheet control.
TdxSpreadSheetExternalLink
TdxSpreadSheetExternalLinks
TdxSpreadSheetFormatsRepositoryA repository designed to store the spreadsheet document formats available for use in the Spreadsheet and Report Designer controls.
TdxSpreadSheetFormulaStores a parsed formula expression within a cell object.
TdxSpreadSheetFormulaControllerA spreadsheet formula expression controller.
TdxSpreadSheetHistoryStores and manages the undo and redo action lists in spreadsheet controls.
TdxSpreadSheetHistoryActionThe base class for all classes that implement recorded history actions in an opened spreadsheet document.
TdxSpreadSheetHistoryAddGroupAction
TdxSpreadSheetHistoryChangeConditionalFormattingAction
TdxSpreadSheetHistoryCustomCommandThe base class for all classes that implement document change commands in the spreadsheet action history.
TdxSpreadSheetLockedStateImageOptionsStores display settings for a spreadsheet control’s “Locked View“ image.
TdxSpreadSheetMergedCellA cell created from several individual adjacent cells within a Table View worksheet.
TdxSpreadSheetMergedCellListA merged cell collection in a Table View worksheet.
TdxSpreadSheetMergedCellsRow
TdxSpreadSheetObjectListThe base class for classes that implement collections used in the ExpressSpreadSheet Suite.
TdxSpreadSheetObjectListItemThe base class for classes that implement collection items used in the ExpressSpreadSheet Suite.
TdxSpreadSheetOptionsBehaviorStores the global behavior and functionality settings of a spreadsheet control.
TdxSpreadSheetOptionsMetadataStores spreadsheet document metadata.
TdxSpreadSheetOptionsViewStores the global apperance and functionality settings of the Spreadsheet and Report Designer controls.
TdxSpreadSheetPageControlA spreadsheet control’s caption bar.
TdxSpreadSheetPageControlHitTestContains a caption bar’s HitTest information.
TdxSpreadSheetPersistentObjectThe base class for all classes that implement persistent objects, including property sets, in the ExpressSpreadSheet Suite.
TdxSpreadSheetRTFServiceProvides access to the text formatting functionality in spreadsheet controls.
TdxSpreadSheetShrinkToFitCalculator
TdxSpreadSheetStylesStores the Styles settings applied to various visual elements of the Spreadsheet and Report Designer controls.
TdxSpreadSheetTableColumnA column within a column collection.
TdxSpreadSheetTableColumnsA column object collection within a Table View worksheet.
TdxSpreadSheetTableItemThe base class for individual column and row objects in a Table View worksheet.
TdxSpreadSheetTableItemGroupAn individual table item group created within the tree-like hierarchy.
TdxSpreadSheetTableItemGroupsA table item group root node within a Table View worksheet.
TdxSpreadSheetTableItemsThe base class for table item collections within a Table View worksheet.
TdxSpreadSheetTableRowA row within a row collection.
TdxSpreadSheetTableRowsA row object collection within the current Table View worksheet.
TdxSpreadSheetTableViewA worksheet type (View) designed for tabular data visualization and processing.
TdxSpreadSheetTableViewAbstractCellViewInfo
TdxSpreadSheetTableViewCellViewInfo
TdxSpreadSheetTableViewCellViewInfoList
TdxSpreadSheetTableViewCustomCellViewInfo
TdxSpreadSheetTableViewCustomDataCellViewInfo
TdxSpreadSheetTableViewCustomGroupingAreaViewInfo
TdxSpreadSheetTableViewHeaderCellViewInfo
TdxSpreadSheetTableViewHitTestContains HitTest information of the Table View worksheet.
TdxSpreadSheetTableViewInfo
TdxSpreadSheetTableViewMergedCellViewInfo
TdxSpreadSheetTableViewMergedCellViewInfoList
TdxSpreadSheetTableViewOptionsStores general worksheet settings.
TdxSpreadSheetTableViewOptionsPrintStores all print-related settings that an individual worksheet has.
TdxSpreadSheetTableViewPainter
TdxSpreadSheetTableViewSelectionA collection of selected areas in a worksheet.
TdxSpreadSheetTableViewSelectionViewInfo
TdxSpreadSheetTextServiceThe base class for all classes that implement the text formatting functionality in spreadsheet controls.
TdxSpreadSheetViewAbstractCellViewInfo
TdxSpreadSheetViewPersistentObjectThe base class for all classes that implement worksheet View-specific persistent objects in a Spreadsheet control.

Interfaces

Name
IdxSpreadSheet
IdxSpreadSheetEditControllerListener
IdxSpreadSheetKeyboardListener
IdxSpreadSheetListener
IdxSpreadSheetListener2
IdxSpreadSheetOptionsPrintListener
IdxSpreadSheetSelectionListener
IdxSpreadSheetTableView
IdxSpreadSheetTableViewSelectionModeListener

Enums

NameDescription
TdxSpreadSheetChangeEnumerates changes made in an opened spreadsheet document.
TdxSpreadSheetContainerAnchorTypeEnumerates anchoring modes available for the floating containers.
TdxSpreadSheetContainerRestrictionEnumerates the restrictions that can be imposed on end-user interactions with floating container objects.
TdxSpreadSheetPageControlButtonEnumerates the worksheet creation and tab scroll buttons on the caption bar.
TdxSpreadSheetStateEnumerates specific states of the Spreadsheet and Report Designer controls.
TdxSpreadSheetTableItemGroupExpandButtonPositionEnumerates available table item group expand button positions.
TdxSpreadSheetTableViewClearCellsOptionEnumerates operations that a cell clear operation can include.
TdxSpreadSheetTableViewMergedCellsConflictResolutionEnumerates the possible variants of the worksheet behavior when the cell management operation area intersects the merged cell object‘s area.
TdxSpreadSheetTableViewSelectionMode

Methods

NameDescription
dxSpreadSheetFormatsRepositoryReturns the repository storing references to spreadsheet document format implementations that you can use for importing/exporting data to/from the Spreadsheet and Report Designer controls.

Variables

NameDescription
dxSpreadSheetTextServiceProvides access to the registered cell text formatting service via a class-reference.

Constants

NameDescription
dxSpreadSheetBestFitWidthCorrectionPercentageSpecifies the extra width (as a percentage of the content width) added to cells with unformatted string values during best fit calculations.
dxSpreadSheetContainerRotateMarkerColor1Specifies the color of both the first and last gradient points which are used to paint the container rotation handle’s internal area.
dxSpreadSheetContainerRotateMarkerColor2Specifies the color of the intermediate gradient point which is used to paint the container rotation handle’s internal area.
dxSpreadSheetContainerRotateMarkerSizeSpecifies the absolute diameter (in pixels) of the container rotation handle.
dxSpreadSheetContainerSelectionFrameColorSpecifies the color of the bounding box displayed by the selected floating container object.
dxSpreadSheetContainerSizingMarkerColor1Specifies the color of both the first and last gradient points which are used to paint the container sizing handle’s internal area.
dxSpreadSheetContainerSizingMarkerColor2Specifies the color of the intermediate gradient point which is used to paint the container sizing handle’s internal area.
dxSpreadSheetContainerSizingMarkerSizeSpecifies both the absolute width and height (in pixels) of the container sizing handle.
dxSpreadSheetMovingClonedContainerAlphaSpecifies the minimum transparency level applied to the floating container object during the clone operation.
dxSpreadSheetMovingContainerAlphaSpecifies the minimum transparency level applied to the floating container object during the move operation.
dxSpreadSheetResizingContainerAlphaSpecifies the minimum transparency level applied to the floating container object during the sizing operation.
dxSpreadSheetRotationContainerAlphaSpecifies the minimum transparency level applied to the floating container object during the rotation operation.
hcBackground
hcButton
hcCell
hcColumnHeader
hcContainer
hcContainerSelection
hcExpandButton
hcFrozenPaneSeparator
hcGroup
hcGroupingArea
hcHyperlinkSpecifies the HitTest code corresponding to a hyperlink displayed in a PDF document.
hcPageTab
hcResizeArea
hcRowHeader
hcSelectionFrame
hcSplitter
ssvsBackground
ssvsContent
ssvsHeader
ssvsPageControl
ssvsSelection

Types

NameDescription
TdxSpreadSheetCellCommentHideEventThe procedural type of a comment autohide notification event.
TdxSpreadSheetCellCommentShowEventThe procedural type of a comment automatic display event.
TdxSpreadSheetCellStyle
TdxSpreadSheetChangesA set of changes that occurred in an opened document as a result of an operation performed in a spreadsheet control.
TdxSpreadSheetContainerClassThe class-reference to the base floating container class.
TdxSpreadSheetContainerEnumProcA reference to an anonymous function which iterates through floating container objects.
TdxSpreadSheetContainerRestrictionsA set of restriction flags applied to end-user interaction with a floating container object.
TdxSpreadSheetCustomConditionalFormattingRuleThe base class for all conditional formatting rule classes.
TdxSpreadSheetCustomDrawTableViewCellEvent
TdxSpreadSheetCustomDrawTableViewCommonCellEvent
TdxSpreadSheetCustomDrawTableViewHeaderCellEvent
TdxSpreadSheetCustomFormatClassThe class-reference to a spreadsheet document format class.
TdxSpreadSheetCustomReaderClassA reference to the class that implements routines designed to load data from a stream in a specific spreadsheet document format.
TdxSpreadSheetCustomViewClassThe class-reference to a worksheet class.
TdxSpreadSheetCustomWriterClassA reference to the class that implements routines designed to save a Spreadsheet control’s content to a stream in a specific spreadsheet document format.
TdxSpreadSheetHistoryActionClassA class-reference to a history action class.
TdxSpreadSheetHyperlinkExecuteEventThe hyperlink activation event procedural type.
TdxSpreadSheetMergedCellListEnumCellsProcA reference to an anonymous procedure which iterates through multiple merged cells.
TdxSpreadSheetMergedCellListEnumRowsProc
TdxSpreadSheetPageControlButtonsA set of worksheet creation and tab scroll buttons.
TdxSpreadSheetPageControlContextPopupEventThe procedural type of the caption bar popup menu display event.
TdxSpreadSheetPageControlNewTabButtonClickEventThe procedural type of the “Add Sheet” button activation event.
TdxSpreadSheetPageControlTabDragAndDropEventThe procedural type of a worksheet tab position change during a drag-and-drop operation.
TdxSpreadSheetPageControlTabEndDragEventThe procedural type of a worksheet tab drop notification event.
TdxSpreadSheetPageControlTabStartDragEventThe procedural type of a worksheet tab drag initiation event.
TdxSpreadSheetPrepareLockedStateImageEventThe “Locked View” image draw event type used by the Spreadsheet and Report Designer controls.
TdxSpreadSheetProgressEvent
TdxSpreadSheetScrollEventThe type of worksheet scroll notification events that occur in the Spreadsheet and Report Designer controls.
TdxSpreadSheetStatesA set of Spreadsheet and Report Designer control states.
TdxSpreadSheetTableItemEnumProcA reference to an anonymous procedure that iterates through multiple cell objects in a single row.
TdxSpreadSheetTableViewActiveCellChangingEvent
TdxSpreadSheetTableViewClearCellsOptionsA set of cell clear operations.
TdxSpreadSheetTableViewContextPopupEventThe procedural type of the worksheet context menu display event.
TdxSpreadSheetTableViewForEachCellProcA reference to an anonymous procedure that iterates through multiple occupied cells in a worksheet and applies the same changes to all such cells.
TdxSpreadSheetTextServiceClassThe class-reference to a cell text formatting service.
TdxSpreadSheetViewCompareValuesEvent
TdxSpreadSheetViewInitInplaceEditEvent
TdxSpreadSheetViewInitInplaceEditValueEvent
TdxSpreadSheetViewInplaceEditingEvent
TdxSpreadSheetViewNotifyEventThe worksheet event notification type.