Back to Devexpress

DevExpress.XtraSpreadsheet Namespace

officefileapi-devexpress-04807ec4.md

latest21.8 KB
Original Source

DevExpress.XtraSpreadsheet Namespace

Contains the SpreadsheetControl class that provides the main functionality of the XtraSpreadsheet Suite.

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Classes

NameDescription
AfterDropRangeEventArgsProvides data for the SpreadsheetControl.AfterDropRange event.
AfterFillRangeEventArgsProvides data for the SpreadsheetControl.AfterFillRange event.
AfterGroupProcessingEventArgsContains data for the SpreadsheetControl.AfterGroupProcessing event.
AfterOutlineButtonClickEventArgsContains data for the SpreadsheetControl.AfterOutlineButtonClick event.
BeforeDragRangeEventArgsProvides data for the SpreadsheetControl.BeforeDragRange event.
BeforeDropRangeEventArgsProvides data for the SpreadsheetControl.BeforeDropRange event.
BeforeFillRangeEventArgsProvides data for the SpreadsheetControl.BeforeFillRange event.
BeforeGroupProcessingEventArgsContains data for the SpreadsheetControl.BeforeGroupProcessing event.
BeforeOutlineButtonClickEventArgsContains data for the SpreadsheetControl.BeforeOutlineButtonClick event.
DataBindingWarningEventArgsProvides data for the DataBindingWarning event.
DefinedNameDeletingEventArgsProvides data for the SpreadsheetControl.DefinedNameDeleting event.
DefinedNameEditedEventArgsContains DefinedNameEdited event data.
DefinedNameEditingEventArgsProvides data for the SpreadsheetControl.DefinedNameEditing event.
DefinedNameEventArgsContains DefinedNameAdded and DefinedNameDeleted event data.
DefinedNameEventArgsBaseBase class for classes that provides data for the DefinedNameDeleting and DefinedNameEditing events of the SpreadsheetControl.
DocumentPropertiesChangedEventArgsProvides data for the SpreadsheetControl.DocumentPropertiesChanged event.
GroupStateChangedEventArgsContains data for the SpreadsheetControl.GroupStateChanged event.
GroupStateChangingEventArgsContains data for the SpreadsheetControl.GroupStateChanging event.
HyperlinkClickEventArgsProvides data for the SpreadsheetControl.HyperlinkClick event.
RealTimeDataOptionsContains options for real-time data (RTD) function calculation.
SpreadsheetAxisLabelOverlappingOptionsContains options that define how to resolve overlapping axis labels for the SpreadsheetControl’s charts.
SpreadsheetBehaviorOptionsProvides options to restrict an end-user’s ability to manage a document within the SpreadsheetControl.
SpreadsheetCellCancelEditEventArgsProvides data for the SpreadsheetControl.CellCancelEdit event.
SpreadsheetCellCancelEventArgsProvides data for the SpreadsheetControl.CellBeginEdit event and serves as the base class for SpreadsheetCellValidatingEventArgs.
SpreadsheetCellEditorBehaviorOptionsContains options for the cell editor.
SpreadsheetCellEventArgsProvides data for the SpreadsheetControl.CellValueChanged event.
SpreadsheetCellEventArgsBaseServes as the base for classes which provide data for the events which occur on changing cell values via the SpreadsheetControl UI.
SpreadsheetCellOptionsContains various options which can be specified for worksheet cells.
SpreadsheetCellValidatingEventArgsProvides data for the SpreadsheetControl.CellEndEdit event.
SpreadsheetChartsViewOptionsProvides access to the chart-specific properties of the SpreadsheetControl.
SpreadsheetClipboardOptionsContains clipboard options for the Spreadsheet control.
SpreadsheetColumnBehaviorOptionsProvides options to restrict an end-user’s ability to manage columns in a worksheet of the workbook loaded into SpreadsheetControl.
SpreadsheetCommentBehaviorOptionsProvides options to restrict an end-user’s ability to modify comments embedded into the SpreadsheetControl‘s document.
SpreadsheetCompatibilityOptionsContains options used to ensure compatibility with previous Spreadsheet versions.
SpreadsheetCopyOptionsA set of options used to control copy operations.
SpreadsheetDataSourceLoadingOptionsContains options which affect how the mail merge data source is created and its data is loaded.
SpreadsheetDataValidationBehaviorOptionsProvides options to restrict an end-user’s capability to manage data validation rules in a document loaded into SpreadsheetControl.
SpreadsheetDecryptionExceptionFires under certain conditions when an attempt to load a password-protected .xls file fails.
SpreadsheetDrawingBehaviorOptionsProvides options to restrict an end-user’s ability to modify drawing objects embedded into the SpreadsheetControl‘s document.
SpreadsheetFillHandleBehaviorOptionsContains an option which turns the Fill Handle feature on or off.
SpreadsheetFormulaAutoCompleteOptionsContains options affecting the Formula AutoComplete functionality.
SpreadsheetGroupBehaviorOptionsProvides options to restrict an end-user’s ability to group data.
SpreadsheetPivotTableFieldListOptionsContains options that specify the size and starting position of the PivotTable Field List pane at runtime.
SpreadsheetPrintOptionsProvides access to options that control how the printed document is generated and previewed.
SpreadsheetProtectionBehaviorOptionsProvides options to restrict an end-user’s capability to protect or unprotect a document in the SpreadsheetControl.
SpreadsheetProtectionOptionsProvides access to options specifying the encryption parameters.
SpreadsheetRowBehaviorOptionsProvides options to restrict an end-user’s ability to manage rows in a worksheet of the workbook loaded into SpreadsheetControl.
SpreadsheetSelectionOptionsContains options affecting cell selection in the SpreadsheetControl.
SpreadsheetUnhandledExceptionEventArgsProvides data for the UnhandledException event.
SpreadsheetViewOptionsProvides access to a set of display settings of the SpreadsheetControl.
SpreadsheetWorksheetBehaviorOptionsProvides options to restrict an end-user’s ability to manage worksheets of the workbook loaded into SpreadsheetControl.
VisibleRangeChangedEventArgsProvides data for the SpreadsheetControl.VisibleRangeChanged event.
WorkbookCapabilitiesOptionsProvides various options which can be specified for the document loaded in the SpreadsheetControl.
WorkbookEventOptionsProvides options to specify how certain events are raised for the workbook.
WorkbookLayoutOptionsContains document layout options.
WorkbookLocalizationOptionsContains localization options for a workbook.
WorkbookPrintOptionsProvides access to options that control how a printed document is generated and previewed.
WorkbookSaveOptionsProvides access to options which define the file name and file format that are used when saving and loading the workbook.

Structs

NameDescription
SpreadsheetGroupInfoContains information about a row or column group that is collapsed or expanded by a user.

Delegates

NameDescription
AfterDropRangeEventHandlerA method that handles the SpreadsheetControl’s AfterDropRange event.
AfterFillRangeEventHandlerA method that handles the SpreadsheetControl’s AfterFillRange event.
AfterGroupProcessingEventHandlerA method that handles the SpreadsheetControl.AfterGroupProcessing event.
AfterOutlineButtonClickEventHandlerA method that handles the SpreadsheetControl.AfterOutlineButtonClick event.
BeforeDragRangeEventHandlerA method that handles the SpreadsheetControl’s BeforeDragRange event.
BeforeDropRangeEventHandlerA method that handles the SpreadsheetControl’s BeforeDropRange event.
BeforeFillRangeEventHandlerA method that handles the SpreadsheetControl’s BeforeFillRange event.
BeforeGroupProcessingEventHandlerA method that handles the SpreadsheetControl.BeforeGroupProcessing event.
BeforeOutlineButtonClickEventHandlerA method that handles the SpreadsheetControl.BeforeOutlineButtonClick event.
CellBeginEditEventHandlerA method that will handle the SpreadsheetControl.CellBeginEdit event of the SpreadsheetControl.
CellCancelEditEventHandlerA method that will handle the SpreadsheetControl.CellCancelEdit event of the SpreadsheetControl.
CellEndEditEventHandlerA method that will handle the SpreadsheetControl.CellEndEdit event of the SpreadsheetControl.
CellValueChangedEventHandlerA method that will handle the CellValueChanged event of the SpreadsheetControl.
DataBindingWarningEventHandlerA method that will handle the DataBindingWarning event of the SpreadsheetControl.
DefinedNameAddedEventHandlerA method that handles the DefinedNameAdded event of the SpreadsheetControl.
DefinedNameDeletedEventHandlerA method that handles the DefinedNameDeleted event of the SpreadsheetControl.
DefinedNameDeletingEventHandlerA method that will handle the DefinedNameDeleting event of the SpreadsheetControl.
DefinedNameEditedEventHandlerA method that handles the DefinedNameEdited event of the SpreadsheetControl.
DefinedNameEditingEventHandlerA method that will handle the DefinedNameEditing event of the SpreadsheetControl.
DocumentPropertiesChangedEventHandlerA method that will handle the DocumentPropertiesChanged event of the SpreadsheetControl.
GroupStateChangedEventHandlerA method that handles the SpreadsheetControl.GroupStateChanged event.
GroupStateChangingEventHandlerA method that handles the SpreadsheetControl.GroupStateChanging event.
HyperlinkClickEventHandlerA method that will handle the SpreadsheetControl.HyperlinkClick event of the SpreadsheetControl.
UnhandledExceptionEventHandlerRepresents a method that will handle the SpreadsheetControl.UnhandledException event.
VisibleRangeChangedEventHandlerA method that handles the SpreadsheetControl.VisibleRangeChanged event.

Enums

NameDescription
CellEditorCommitModeLists values used to specify when the SpreadsheetControl.CellValueChanged event should be raised after a cell value has been edited via the cell editor and committed.
CellEditorEnterValueModeLists values that specify how to commit a cell value when closing the cell editor.
CellEditorModeLists modes that specify the cell editor and cursor behavior.
CellValueChangedActionLists actions which changed the cell value.
ClipboardPasteFormatLists clipboard formats the Spreadsheet control supports.
DataBindingWarningTypeLists values used to specify the type of data binding warning messages.
DataTransferModeLists values used to determine the operation a user performs on the selected cell range.
DocumentCapabilityLists values used to specify the availability of a certain functionality in the SpreadsheetControl.
DragDropOperationTypeLists values used to specify the drag-and-drop operation type.
FillOperationTypeLists values used to specify how the target cell range is filled with data.
FormulaAutoCompleteSearchModeLists values used to specify what items should appear in the Formula AutoComplete drop-down list.
FunctionNameCultureLists values that specify culture settings for function names in a worksheet.
MoveActiveCellModeOnEnterPressLists values that specify how to move an active cell on an ENTER key press.
RealTimeDataRefreshModeLists how a data update is initiated.
ShowSelectionModeLists values used to specify whether the cell selection should be highlighted when the SpreadsheetControl is not focused.
SpreadsheetCustomAssemblyBehaviorLists actions which can be performed in response to a request for loading a custom assembly for the Entity Framework Data Source.
SpreadsheetDecryptionErrorLists possible errors which occur while attempting to load a password protected encrypted workbook.
SpreadsheetPivotTableFieldListStartPositionLists values used to specify the starting position of the PivotTable Field List.
SpreadsheetPrintContentLists values that specify spreadsheet content to print.
SpreadsheetPrintRenderModeLists values used to specify the render mode for the printed document.