Back to Devexpress

Workbook Events

officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-underscore-events.md

latest24.0 KB
Original Source

Workbook Events

A non-visual component that allows you to generate and modify spreadsheet documents.

NameDescription
ActiveSheetChanged

Occurs after an active worksheet in a workbook has been changed.

You need a license for the DevExpress Office File API Subscription 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 need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | BeforeEncodingDetection | Occurs before detecting the encoding of the loaded CSV or TXT data. | | BeforeExport |

Occurs before the document is saved (exported to a certain format).

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | BeforeImport |

Occurs before a document is loaded (imported from an external source).

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | BeforePrintSheet |

Occurs before printing a workbook.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ClipboardDataObtained |

Occurs after data on the clipboard is obtained and recognized, but before data is actually pasted.

You need a license for the DevExpress Office File API Subscription 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 need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ClipboardDataPasting |

Occurs before data is pasted into destination cells.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ColumnsInserted |

Occurs after new columns have been added to a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ColumnsInserting |

Occurs before new columns are added to a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ColumnsRemoved |

Occurs after columns have been deleted from a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ColumnsRemoving |

Occurs before columns are removed from a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ColumnWidthChanged |

Occurs after the column width was changed.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | CommentInserted |

Occurs after a comment was inserted.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | CommentInserting |

Occurs before a comment is inserted.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | CommentRemoved |

Occurs after a comment was deleted.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | CommentRemoving |

Occurs before a comment is deleted.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ContentChanged |

Occurs when a workbook’s undo history changes. The Undo history is not logged for a Workbook instance by default, so the event is not raised.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | CopiedRangePasted |

Occurs after the range content has been pasted into target cells.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | CopiedRangePasting |

Occurs before the range content is pasted into target cells.

You need a license for the DevExpress Office File API Subscription 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. Allows you to cancel loading.

You need a license for the DevExpress Office File API Subscription 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 need a license for the DevExpress Office File API Subscription 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 need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.

| | DocumentLoaded |

Occurs after a document is loaded.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | DocumentSaved |

Occurs after a document has been saved.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | EmptyDocumentCreated |

Occurs when a new document is created.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | EncryptedFileIntegrityCheckFailed |

Raises when the encrypted file did not pass the data integrity verification.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | EncryptedFilePasswordCheckFailed |

Occurs when the encryption password is empty or invalid.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | EncryptedFilePasswordRequest |

Raises when the WorkbookImportOptions.Password property is not set or contains a wrong password.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | InitializeDocument |

Occurs before a document is loaded. Handle this event to set initial document settings.

You need a license for the DevExpress Office File API Subscription 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 need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ModifiedChanged |

Occurs when the value of the Workbook.Modified property is changed.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | PanesFrozen |

Occurs after a worksheet area has been frozen.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | PanesUnfrozen |

Occurs after a frozen worksheet area has been unlocked.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | RangeCopied |

Occurs after the range content has been copied.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | RangeCopying |

Occurs before a cell range is copied in a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | RowHeightChanged |

Occurs after the row height was changed.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | RowsInserted |

Occurs after new rows have been added to a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | RowsInserting |

Occurs before new rows are added to a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | RowsRemoved |

Occurs after rows have been deleted from a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | RowsRemoving |

Occurs before rows are removed from a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | SchemaChanged |

Occurs when a worksheet or defined name is renamed, inserted or deleted.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ScrollPositionChanged |

Occurs when the scroll position changes in a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | SelectionChanged |

Fires when the selection changes in a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ShapeInserted |

Occurs after a drawing object has been inserted into a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ShapeRemoved |

Occurs after a drawing object has been removed from a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ShapeRemoving |

Occurs before a drawing object is removed from a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ShapesCopying |

Occurs before a drawing object is copied in a worksheet.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | SheetInserted |

Occurs after a new worksheet has been added to a workbook.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | SheetRemoved |

Occurs after a worksheet has been removed from a workbook.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | SheetRemoving |

Occurs before a worksheet is removed from a workbook.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | SheetRenamed |

Occurs after a worksheet has been renamed.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | SheetRenaming |

Occurs when a worksheet is about to be renamed.

You need a license for the DevExpress Office File API Subscription 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 need a license for the DevExpress Office File API Subscription 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 need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

| | ValidateCustomSqlQuery |

Allows you to validate a custom SQL query created in the Data Source Wizard.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this event in production code.

|

See Also

Workbook Class

Workbook Members

DevExpress.Spreadsheet Namespace