Workbook Events
A non-visual component providing complete spreadsheet functionality.
You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this class in production code.
Name | Description |
---|---|
ActiveSheetChanged |
Occurs after an active worksheet in a workbook has been changed. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ActiveSheetChanging |
Occurs when an active worksheet in a workbook is about to be changed. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
BeforeExport |
Occurs before the document is saved (exported to a certain format). You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
BeforeImport |
Occurs before a document is loaded (imported from an external source). You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
BeforePrintSheet | Occurs before printing a workbook. |
ClipboardDataObtained |
Occurs after data on the clipboard is obtained and recognized, but before data is actually pasted. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ClipboardDataPasted |
Occurs after data has been pasted from the clipboard onto a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ClipboardDataPasting |
Occurs before data is pasted into destination cells. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ColumnsInserted |
Occurs after new columns have been added to a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ColumnsInserting | Occurs before inserting new columns into a worksheet. |
ColumnsRemoved |
Occurs after columns have been deleted from a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ColumnsRemoving | Occurs before deleting columns from a worksheet. |
CommentInserted | Occurs when a comment is inserted. |
CommentInserting | Occurs before inserting a comment. |
CommentRemoved | Occurs when a comment is deleted. |
CommentRemoving | Occurs before deleting a comment. |
ContentChanged |
Occurs when the workbook’s undo history changes. By default, undo history is not logged for the Workbook instance, so the event is not raised. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
CopiedRangePasted |
Occurs after the range content has been pasted into target cells. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
CopiedRangePasting |
Occurs before the range content is pasted into target cells. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
CustomAssemblyLoading |
Occurs before a custom assembly is loaded for use as the Entity Framework data source during mail merge and allows cancelling loading. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
DefinedNameConflictResolving |
Occurs when the formula or sheet being moved or copied contains a defined name which already exists on the destination worksheet or workbook. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
DocumentClosing |
Occurs when a document that has not yet been saved is about to be closed. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this property in production code. |
DocumentLoaded |
Occurs after a document is loaded. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
DocumentSaved |
Occurs after a document has been saved. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
EmptyDocumentCreated |
Occurs when a new document is created. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
EncryptedFileIntegrityCheckFailed | Raises when the encrypted file did not pass the data integrity verification. |
EncryptedFilePasswordCheckFailed | Occurs when the encryption password is empty or invalid. |
EncryptedFilePasswordRequest | Raises when the WorkbookImportOptions.Password property is not set or contains a wrong password. |
InitializeDocument |
Occurs before a document is loaded. Handle this event to set initial document settings. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
InvalidFormatException |
Fires when the supplied data could not be recognized as data in the assumed format for import. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ModifiedChanged |
Occurs when the value of the Workbook.Modified property is changed. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
PanesFrozen |
Occurs after a worksheet area has been frozen. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
PanesUnfrozen |
Occurs after a frozen worksheet area has been unlocked. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
RangeCopied |
Occurs after the range content has been copied. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
RangeCopying |
Occurs before a cell range is copied in a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
RowsInserted |
Occurs after new rows have been added to a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
RowsInserting | Occurs before inserting new rows into a worksheet. |
RowsRemoved |
Occurs after rows have been deleted from a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
RowsRemoving | Occurs before deleting rows from a worksheet. |
SchemaChanged |
Occurs when a worksheet or defined name is renamed, inserted or deleted. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ScrollPositionChanged |
Occurs when the scroll position changes in a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
SelectionChanged |
Fires when the selection changes in a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ShapeInserted |
Occurs after a drawing object has been inserted into a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ShapeRemoved |
Occurs after a drawing object has been removed from a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ShapeRemoving |
Occurs before a drawing object is removed from a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ShapesCopying |
Occurs before a drawing object is copied in a worksheet. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
SheetInserted |
Occurs after a new worksheet has been added to a workbook. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
SheetRemoved |
Occurs after a worksheet has been removed from a workbook. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
SheetRemoving | Occurs before a worksheet is removed from a workbook. |
SheetRenamed |
Occurs after a worksheet has been renamed. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
SheetRenaming |
Occurs when a worksheet is about to be renamed. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
UnitChanged |
Fires after a unit of measurement used in the workbook is changed. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
UnitChanging |
Fires before a unit of measurement used within the workbook is changed. You require a license to the DevExpress Office File API or DevExpress Universal Subscription to use this event in production code. |
ValidateCustomSqlQuery | Allows validation of the custom SQL query created using the Data Source Wizard. |