.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

IWorkbook Members

Exposes the specific functionality of a workbook.

Properties

Name Description
ChartSheets Provides access to a collection of chart sheets contained in the workbook.
Clipboard Provides access to the object used for working with the system Clipboard. Inherited from ISpreadsheetComponent.
CreatesIntersectedBricks Inherited from IBasePrintable.
CurrentAuthor Gets the system username.
CustomFunctions Provides access to a collection of custom functions in a workbook.
CustomXmlParts Provides access to a workbook's collection of custom XML parts.
DefinedNames Gets the collection of defined names whose scope is the current workbook.
DocumentProperties Provides access to the document properties associated with a workbook.
DocumentSettings Provides access to the settings that specify how the calculation is performed and what reference style is used.
ExternalWorkbooks Provides access to the collection of source workbooks used for creating external references in the current workbook.
FormulaEngine Provides access to a FormulaEngine object to parse or evaluate a formula.
Functions Provides access to the built-in functions in a workbook.
GlobalCustomFunctions Provides access to a collection of custom functions which are not limited in scope to the workbook in which the functions reside.
HasMacros Determines whether the workbook has VBA projects (macros).
History Provides access to the history of operations performed in a workbook.
IsDisposed Gets a value indicating whether a workbook has been disposed of.
IsProtected Gets whether the workbook is protected.
MailMergeDataMember Specifies the member of the mail merge data source.
MailMergeDataSource Specifies the data source for the mail merge.
MailMergeOptions Provides access to the mail merge options.
MailMergeParameters Provides access to a collection of parameters for queries used to obtain data in mail merge.
Model For internal use.
Modified Gets or sets whether the document content was modified since it was last saved. Inherited from ISpreadsheetComponent.
Options Provides access to various options which can be specified for the workbook. Inherited from ISpreadsheetComponent.
Path Gets the path to the spreadsheet file loaded as an external workbook. Inherited from ExternalWorkbook.
PivotCaches Provides access to the collection of all the PivotTable caches in the specified workbook.
Range Provides access to the cell range in the worbook.
RealTimeData Provides access to an object that is used to manually update real-time data and reconnect to data servers.
Sheets Provides access to a collection of all sheets contained in the workbook.
Styles Provides access to the collection of cell styles in the current workbook.
TableStyles Provides access to the collection of styles to format tables and pivot tables in the workbook.
Tag Gets or sets the data associated with an IWorkbook object.
Unit Gets or sets a unit of measure used in the workbook. Inherited from ISpreadsheetComponent.
Worksheets Returns the collection of worksheets in a workbook.

Methods

Name Description
AddService(Type, ServiceCreatorCallback) Adds the specified service to the service container. Inherited from IServiceContainer.
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, Object) 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.
Calculate() Forces recalculation of the workbook.
Calculate(CellRange) Forces recalculation of the specified cell range in a worksheet.
Calculate(Worksheet) Forces recalculation of the specified worksheet in a workbook.
CalculateFull() Forces a full calculation of the data in a workbook.
CalculateFullRebuild() Forces a full calculation of cell formulas in a workbook.
CreateArea(String, IBrickGraphics) When implemented by a class, creates report elements (bricks) for a specific area. Inherited from IBasePrintable.
CreateNewDocument() Creates and loads a new empty workbook. Inherited from ISpreadsheetComponent.
Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Inherited from IDisposable.
Evaluate(String) Evaluates the specified formula.
Evaluate(String, FormulaEvaluationContext) Evaluates the specified formula in a certain context.
ExportToHtml(Stream, CellRange) Exports the specified range to the specified stream in HTML format.
ExportToHtml(Stream, Worksheet) Exports the specified worksheet to the specified stream in HTML format.
ExportToHtml(Stream, HtmlDocumentExporterOptions) Exports the document's data to the specified stream in HTML format using the specified options.
ExportToHtml(Stream, Int32) Exports the specified worksheet to the specified stream in HTML format.
ExportToHtml(String, CellRange) Exports the specified range to the specified file in HTML format.
ExportToHtml(String, Worksheet) Exports the specified worksheet to the specified file in HTML format.
ExportToHtml(String, HtmlDocumentExporterOptions) Exports the document's data to the specified file in HTML format using the specified options.
ExportToHtml(String, Int32) Exports the specified worksheet to the specified file in HTML format.
ExportToPdf(Stream) Exports the workbook to the specified stream in PDF format.
ExportToPdf(Stream, PdfExportOptions) Exports the workbook to the specified stream in PDF format using the specified options.
ExportToPdf(String) Exports the workbook to the specified file path in PDF format.
ExportToPdf(String, PdfExportOptions) Exports the workbook to the specified file path in PDF format using the specified options.
Finalize(IPrintingSystem, ILink) If implemented by a class, finalizes the printing of the report. Inherited from IBasePrintable.
GenerateMailMergeDocuments() Performs the mail merge and returns the collection of resulting workbooks.
GetService(Type) Gets the service object of the specified type. Inherited from IServiceProvider.
Initialize(IPrintingSystem, ILink) When implemented by a class, initializes a control for report creation. Inherited from IBasePrintable.
LoadDocument(Byte[]) Loads the document from a Byte[] array. Inherited from ISpreadsheetComponent.
LoadDocument(Byte[], DocumentFormat) Loads a document from a byte array. Inherited from ISpreadsheetComponent.
LoadDocument(Stream) Loads the document from a stream. Inherited from ISpreadsheetComponent.
LoadDocument(Stream, DocumentFormat) Loads a document from a stream, specifying the document format. Inherited from ISpreadsheetComponent.
LoadDocument(String) Loads a document from a file. Inherited from ISpreadsheetComponent.
LoadDocument(String, DocumentFormat) Loads a document from a file, specifying the document format. Inherited from ISpreadsheetComponent.
Protect(String, Boolean, Boolean) Protects the structure and windows of a workbook.
RemoveService(Type) Removes the specified service type from the service container. Inherited from IServiceContainer.
RemoveService(Type, Boolean) Removes the specified service type from the service container, and optionally promotes the service to parent service containers. Inherited from IServiceContainer.
SaveDocument(DocumentFormat) Saves a document to an array of bytes in the specified format. Inherited from ISpreadsheetComponent.
SaveDocument(DocumentFormat, EncryptionSettings) Saves a document to an array of bytes in the specified format with the specified encryption settings. Inherited from ISpreadsheetComponent.
SaveDocument(Stream, DocumentFormat) Saves the document to a stream, specifying the document format. Inherited from ISpreadsheetComponent.
SaveDocument(Stream, DocumentFormat, EncryptionSettings) Saves the document to a stream, specifying the document format anf encryption options. Inherited from ISpreadsheetComponent.
SaveDocument(String) Saves the document to the specified file. The file format is identified by the file extension. Inherited from ISpreadsheetComponent.
SaveDocument(String, DocumentFormat) Saves the document to a file, specifying the document format. Inherited from ISpreadsheetComponent.
SaveDocument(String, DocumentFormat, EncryptionSettings) Saves the document to a file, specifying the document format and encryption options. Inherited from ISpreadsheetComponent.
SaveDocument(String, EncryptionSettings) Saves the document to the specified file with the specified encryption options. The file format is identified by the file extension. Inherited from ISpreadsheetComponent.
Search(String) Performs a search in the current document using the default parameters.
Search(String, SearchOptions) Performs a search in the current document using specified options.
Unprotect(String) Removes protection from a workbook.

Events

Name Description
ActiveSheetChanged Occurs after an active worksheet in a workbook has been changed. Inherited from ISpreadsheetComponent.
ActiveSheetChanging Occurs when an active worksheet in a workbook is about to be changed. Inherited from ISpreadsheetComponent.
BeforeExport Occurs before the document is saved (exported to a certain format). Inherited from ISpreadsheetComponent.
BeforeImport Occurs before a document is loaded (imported from an external source). Inherited from ISpreadsheetComponent.
BeforePrintSheet Occurs before printing a workbook. Inherited from ISpreadsheetComponent.
ClipboardDataObtained Occurs after data on the Clipboard is obtained and recognized, but before data is actually pasted. Inherited from ISpreadsheetComponent.
ClipboardDataPasted Occurs after data has been pasted from the Clipboard onto a worksheet. Inherited from ISpreadsheetComponent.
ClipboardDataPasting Occurs before data is pasted from the Clipboard. Inherited from ISpreadsheetComponent.
ColumnsInserted Occurs after new columns have been added to a worksheet. Inherited from ISpreadsheetComponent.
ColumnsInserting Occurs when new columns are about to be inserted into a worksheet. Inherited from ISpreadsheetComponent.
ColumnsRemoved Occurs after columns have been deleted from a worksheet. Inherited from ISpreadsheetComponent.
ColumnsRemoving Occurs when columns are about to be deleted from a worksheet. Inherited from ISpreadsheetComponent.
ColumnWidthChanged Occurs after the column width was changed. Inherited from ISpreadsheetComponent.
CommentInserted Occurs when a comment is inserted. Inherited from ISpreadsheetComponent.
CommentInserting Occurs before inserting a comment. Inherited from ISpreadsheetComponent.
CommentRemoved Occurs when a comment is deleted. Inherited from ISpreadsheetComponent.
CommentRemoving Occurs before deleting a comment. Inherited from ISpreadsheetComponent.
CopiedRangePasted Occurs after the range content has been pasted into target cells. Inherited from ISpreadsheetComponent.
CopiedRangePasting Occurs before the range content is pasted into target cells. Inherited from ISpreadsheetComponent.
CustomAssemblyLoading Occurs before a custom assembly is loaded for use as the Entity Framework data source during mail merge and allows cancelling loading. Inherited from ISpreadsheetComponent.
DefinedNameConflictResolving Occurs when a formula or sheet being moved or copied contains the defined name, which already exists on the destination worksheet or workbook. Inherited from ISpreadsheetComponent.
DocumentClosing Occurs when a document that has not yet been saved is about to be closed. Inherited from ISpreadsheetComponent.
DocumentLoaded Occurs after a document is loaded. Inherited from ISpreadsheetComponent.
DocumentSaved Occurs after a document has been saved. Inherited from ISpreadsheetComponent.
EmptyDocumentCreated Occurs when a new document is created. Inherited from ISpreadsheetComponent.
EncryptedFileIntegrityCheckFailed Raises when the encrypted file did not pass the data integrity verification. Inherited from ISpreadsheetComponent.
EncryptedFilePasswordCheckFailed Occurs when the encryption password is empty or invalid. Inherited from ISpreadsheetComponent.
EncryptedFilePasswordRequest Raises when the WorkbookImportOptions.Password property is not set or contains a wrong password. Inherited from ISpreadsheetComponent.
InitializeDocument Occurs before a document is loaded. Handle this event to set initial document settings. Inherited from ISpreadsheetComponent.
InvalidFormatException Fires when the supplied data could not be recognized as data in the assumed format for import. Inherited from ISpreadsheetComponent.
ModifiedChanged Occurs when the value of the ISpreadsheetComponent.Modified property is changed. Inherited from ISpreadsheetComponent.
PanesFrozen Occurs after a worksheet area has been frozen. Inherited from ISpreadsheetComponent.
PanesUnfrozen Occurs after a frozen worksheet area has been unlocked. Inherited from ISpreadsheetComponent.
RangeCopied Occurs after the range content has been copied. Inherited from ISpreadsheetComponent.
RangeCopying Occurs before a cell range is copied in a worksheet. Inherited from ISpreadsheetComponent.
RowHeightChanged Occurs after the row height was changed. Inherited from ISpreadsheetComponent.
RowsInserted Occurs after new rows have been added to a worksheet. Inherited from ISpreadsheetComponent.
RowsInserting Occurs when new rows are about to be inserted into a worksheet. Inherited from ISpreadsheetComponent.
RowsRemoved Occurs after rows have been deleted from a worksheet. Inherited from ISpreadsheetComponent.
RowsRemoving Occurs when rows are about to be deleted from a worksheet. Inherited from ISpreadsheetComponent.
SchemaChanged Occurs when the schema of an external workbook is changed (a new worksheet is added, a new defined name appears etc.). Inherited from ExternalWorkbook.
ScrollPositionChanged Occurs when the scroll position changes in a worksheet. Inherited from ISpreadsheetComponent.
SelectionChanged Fires in response to changing cell selection in a worksheet. Inherited from ISpreadsheetComponent.
ShapeInserted Occurs after a drawing object has been inserted into a worksheet. Inherited from ISpreadsheetComponent.
ShapeRemoved Occurs after a drawing object has been removed from a worksheet. Inherited from ISpreadsheetComponent.
ShapeRemoving Occurs before a drawing object is removed from a worksheet. Inherited from ISpreadsheetComponent.
ShapesCopying Occurs before a drawing object is copied in a worksheet. Inherited from ISpreadsheetComponent.
SheetInserted Occurs after a new worksheet has been added to a workbook. Inherited from ISpreadsheetComponent.
SheetRemoved Occurs after a worksheet has been removed from a workbook. Inherited from ISpreadsheetComponent.
SheetRemoving Occurs when a worksheet is about to be removed from a workbook. Inherited from ISpreadsheetComponent.
SheetRenamed Occurs after a worksheet has been renamed. Inherited from ISpreadsheetComponent.
SheetRenaming Occurs when a worksheet is about to be renamed. Inherited from ISpreadsheetComponent.
UnitChanged Fires after a unit of measurement used in the workbook is changed. Inherited from ISpreadsheetComponent.
UnitChanging Fires before a unit of measurement used within the workbook is changed. Inherited from ISpreadsheetComponent.
See Also