Back to Devexpress

ISpreadsheetComponent Members

officefileapi-devexpress-dot-spreadsheet-dot-ispreadsheetcomponent-dot-underscore-members.md

latest16.4 KB
Original Source

ISpreadsheetComponent Members

Exposes the basic functionality to manage workbooks.

Properties

NameDescription
ClipboardProvides access to the object used for working with the system Clipboard.
ModifiedGets or sets whether the document content was modified since it was last saved.
OptionsProvides access to various options which can be specified for the workbook.
UnitGets or sets a unit of measure used in the workbook.

Methods

NameDescription
AddService(Type, ServiceCreatorCallback, Boolean)Adds the specified service to the service container, and optionally promotes the service to parent service containers. Inherited from IServiceContainer.
AddService(Type, ServiceCreatorCallback)Adds the specified service to the service container. Inherited from IServiceContainer.
AddService(Type, Object, Boolean)Adds the specified service to the service container, and optionally promotes the service to any parent service containers. Inherited from IServiceContainer.
AddService(Type, Object)Adds the specified service to the service container. Inherited from IServiceContainer.
CreateNewDocument()Creates and loads a new empty workbook.
GetService(Type)Gets the service object of the specified type. Inherited from IServiceProvider.
LoadDocument(Byte[], DocumentFormat)Loads a document from a byte array.
LoadDocument(Byte[])Loads the document from a Byte[] array.
LoadDocument(Stream, DocumentFormat)Loads a document from a stream, specifying the document format.
LoadDocument(Stream)Loads the document from a stream.
LoadDocument(String, DocumentFormat)Loads a document from a file, specifying the document format.
LoadDocument(String)Loads a document from a file.
RemoveService(Type, Boolean)Removes the specified service type from the service container, and optionally promotes the service to parent service containers. Inherited from IServiceContainer.
RemoveService(Type)Removes the specified service type from the service container. Inherited from IServiceContainer.
SaveDocument(DocumentFormat, EncryptionSettings)Saves a document to an array of bytes in the specified format with the specified encryption settings.
SaveDocument(DocumentFormat)Saves a document to an array of bytes in the specified format.
SaveDocument(Stream, DocumentFormat, EncryptionSettings)Saves the document to a stream, specifying the document format anf encryption options.
SaveDocument(Stream, DocumentFormat)Saves the document to a stream, specifying the document format.
SaveDocument(String, DocumentFormat, EncryptionSettings)Saves the document to a file, specifying the document format and encryption options.
SaveDocument(String, DocumentFormat)Saves the document to a file, specifying the document format.
SaveDocument(String, EncryptionSettings)Saves the document to the specified file with the specified encryption options. The file format is identified by the file extension.
SaveDocument(String)Saves the document to the specified file. The file format is identified by the file extension.

Events

NameDescription
ActiveSheetChangedOccurs after an active worksheet in a workbook has been changed.
ActiveSheetChangingOccurs when an active worksheet in a workbook is about to be changed.
BeforeEncodingDetectionOccurs before detecting the encoding of the loaded CSV or TXT data.
BeforeExportOccurs before the document is saved (exported to a certain format).
BeforeImportOccurs before a document is loaded (imported from an external source).
BeforePrintSheetOccurs before printing a workbook.
ClipboardDataObtainedOccurs after data on the Clipboard is obtained and recognized, but before data is actually pasted.
ClipboardDataPastedOccurs after data has been pasted from the Clipboard onto a worksheet.
ClipboardDataPastingOccurs before data is pasted from the Clipboard.
ColumnsInsertedOccurs after new columns have been added to a worksheet.
ColumnsInsertingOccurs when new columns are about to be inserted into a worksheet.
ColumnsRemovedOccurs after columns have been deleted from a worksheet.
ColumnsRemovingOccurs when columns are about to be deleted from a worksheet.
ColumnWidthChangedOccurs after the column width was changed.
CommentInsertedOccurs when a comment is inserted.
CommentInsertingOccurs before inserting a comment.
CommentRemovedOccurs when a comment is deleted.
CommentRemovingOccurs before deleting a comment.
CopiedRangePastedOccurs after the range content has been pasted into target cells.
CopiedRangePastingOccurs before the range content is pasted into target cells.
CustomAssemblyLoadingOccurs before a custom assembly is loaded for use as the Entity Framework data source during mail merge and allows you to cancel loading.
DefinedNameConflictResolvingOccurs when a formula or sheet being moved or copied contains the defined name, which already exists on the destination worksheet or workbook.
DocumentClosingOccurs when a document that has not yet been saved is about to be closed.
DocumentLoadedOccurs after a document is loaded.
DocumentSavedOccurs after a document has been saved.
EmptyDocumentCreatedOccurs when a new document is created.
EncryptedFileIntegrityCheckFailedRaises when the encrypted file did not pass the data integrity verification.
EncryptedFilePasswordCheckFailedOccurs when the encryption password is empty or invalid.
EncryptedFilePasswordRequestRaises when the WorkbookImportOptions.Password property is not set or contains a wrong password.
InitializeDocumentOccurs before a document is loaded. Handle this event to set initial document settings.
InvalidFormatExceptionFires when the supplied data could not be recognized as data in the assumed format for import.
ModifiedChangedOccurs when the value of the ISpreadsheetComponent.Modified property is changed.
PanesFrozenOccurs after a worksheet area has been frozen.
PanesUnfrozenOccurs after a frozen worksheet area has been unlocked.
RangeCopiedOccurs after the range content has been copied.
RangeCopyingOccurs before a cell range is copied in a worksheet.
RowHeightChangedOccurs after the row height was changed.
RowsInsertedOccurs after new rows have been added to a worksheet.
RowsInsertingOccurs when new rows are about to be inserted into a worksheet.
RowsRemovedOccurs after rows have been deleted from a worksheet.
RowsRemovingOccurs when rows are about to be deleted from a worksheet.
ScrollPositionChangedOccurs when the scroll position changes in a worksheet.
SelectionChangedFires in response to changing cell selection in a worksheet.
ShapeInsertedOccurs after a drawing object has been inserted into a worksheet.
ShapeRemovedOccurs after a drawing object has been removed from a worksheet.
ShapeRemovingOccurs before a drawing object is removed from a worksheet.
ShapesCopyingOccurs before a drawing object is copied in a worksheet.
SheetInsertedOccurs after a new worksheet has been added to a workbook.
SheetRemovedOccurs after a worksheet has been removed from a workbook.
SheetRemovingOccurs when a worksheet is about to be removed from a workbook.
SheetRenamedOccurs after a worksheet has been renamed.
SheetRenamingOccurs when a worksheet is about to be renamed.
UnitChangedFires after a unit of measurement used in the workbook is changed.
UnitChangingFires before a unit of measurement used within the workbook is changed.

See Also

ISpreadsheetComponent Interface

DevExpress.Spreadsheet Namespace