IWorkbook Members
In This Article
#Properties
Name | Description |
---|---|
Chart |
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 ISpreadsheet |
Color |
Returns a color palette for the spreadsheet document. |
Creates |
Inherited from IBase |
Current |
Gets the system username. |
Custom |
Provides access to a collection of custom functions in a workbook. |
Custom |
Provides access to a workbook’s collection of custom XML parts. |
Defined |
Gets the collection of defined names whose scope is the current workbook. |
Document |
Provides access to the document properties associated with a workbook. |
Document |
Provides access to the settings that specify how the calculation is performed and what reference style is used. |
External |
Provides access to the collection of source workbooks used for creating external references in the current workbook. |
Formula |
Provides access to a Formula |
Functions | Provides access to the built-in functions in a workbook. |
Global |
Provides access to a collection of custom functions which are not limited in scope to the workbook in which the functions reside. |
Has |
Determines whether the workbook has VBA projects (macros). |
History | Provides access to the history of operations performed in a workbook. |
Is |
Gets a value indicating whether a workbook has been disposed of. |
Is |
Gets whether the workbook is protected. |
Mail |
Specifies the member of the mail merge data source. |
Mail |
Specifies the data source for the mail merge. |
Mail |
Provides access to the mail merge options. |
Mail |
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 ISpreadsheet |
Options |
Provides access to various options which can be specified for the workbook.
Inherited from ISpreadsheet |
Path |
Gets the path to the spreadsheet file loaded as an external workbook.
Inherited from External |
Pivot |
Provides access to the collection of all the Pivot |
Range | Provides access to the cell range in the worbook. |
Real |
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. |
Table |
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. |
Theme | Returns the theme applied to the workbook. |
Unit |
Gets or sets a unit of measure used in the workbook.
Inherited from ISpreadsheet |
Worksheets | Returns the collection of worksheets in a workbook. |
#Methods
Name | Description |
---|---|
Add |
Adds the specified service to the service container, and optionally promotes the service to parent service containers.
Inherited from IService |
Add |
Adds the specified service to the service container.
Inherited from IService |
Add |
Adds the specified service to the service container, and optionally promotes the service to any parent service containers.
Inherited from IService |
Add |
Adds the specified service to the service container.
Inherited from IService |
Calculate() | Forces recalculation of the workbook. |
Calculate |
Forces recalculation of the specified cell range in a worksheet. |
Calculate |
Forces recalculation of the specified worksheet in a workbook. |
Calculate |
Forces a full calculation of the data in a workbook. |
Calculate |
Forces a full calculation of cell formulas in a workbook. |
Create |
When implemented by a class, creates report elements (bricks) for a specific area.
Inherited from IBase |
Create |
Creates and loads a new empty workbook.
Inherited from ISpreadsheet |
Dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Inherited from IDisposable. |
Evaluate |
Evaluates the specified formula in a certain context. |
Evaluate |
Evaluates the specified formula. |
Export |
Exports the specified range to the specified stream in HTML format. |
Export |
Exports the specified worksheet to the specified stream in HTML format. |
Export |
Exports the document’s data to the specified stream in HTML format using the specified options. |
Export |
Exports the specified worksheet to the specified stream in HTML format. |
Export |
Exports the specified range to the specified file in HTML format. |
Export |
Exports the specified worksheet to the specified file in HTML format. |
Export |
Exports the document’s data to the specified file in HTML format using the specified options. |
Export |
Exports the specified worksheet to the specified file in HTML format. |
Export |
Exports the workbook to the specified stream in PDF format using the specified options. |
Export |
Exports the workbook to the specified stream in PDF format. |
Export |
Exports the workbook to the specified file path in PDF format using the specified options. |
Export |
Exports the workbook to the specified file path in PDF format. |
Finalize |
If implemented by a class, finalizes the printing of the report.
Inherited from IBase |
Generate |
Performs the mail merge and returns the collection of resulting workbooks. |
Get |
Gets the service object of the specified type.
Inherited from IService |
Initialize |
When implemented by a class, initializes a control for report creation.
Inherited from IBase |
Load |
Loads a document from a byte array.
Inherited from ISpreadsheet |
Load |
Loads the document from a Byte[] array.
Inherited from ISpreadsheet |
Load |
Loads a document from a stream, specifying the document format.
Inherited from ISpreadsheet |
Load |
Loads the document from a stream.
Inherited from ISpreadsheet |
Load |
Loads a document from a file, specifying the document format.
Inherited from ISpreadsheet |
Load |
Loads a document from a file.
Inherited from ISpreadsheet |
Protect |
Protects the structure and windows of a workbook. |
Remove |
Removes the specified service type from the service container, and optionally promotes the service to parent service containers.
Inherited from IService |
Remove |
Removes the specified service type from the service container.
Inherited from IService |
Save |
Saves a document to an array of bytes in the specified format with the specified encryption settings.
Inherited from ISpreadsheet |
Save |
Saves a document to an array of bytes in the specified format.
Inherited from ISpreadsheet |
Save |
Saves the document to a stream, specifying the document format anf encryption options.
Inherited from ISpreadsheet |
Save |
Saves the document to a stream, specifying the document format.
Inherited from ISpreadsheet |
Save |
Saves the document to a file, specifying the document format and encryption options.
Inherited from ISpreadsheet |
Save |
Saves the document to a file, specifying the document format.
Inherited from ISpreadsheet |
Save |
Saves the document to the specified file with the specified encryption options. The file format is identified by the file extension.
Inherited from ISpreadsheet |
Save |
Saves the document to the specified file. The file format is identified by the file extension.
Inherited from ISpreadsheet |
Search |
Performs a search in the current document using specified options. |
Search |
Performs a search in the current document using the default parameters. |
Unprotect |
Removes protection from a workbook. |
#Events
Name | Description |
---|---|
Active |
Occurs after an active worksheet in a workbook has been changed.
Inherited from ISpreadsheet |
Active |
Occurs when an active worksheet in a workbook is about to be changed.
Inherited from ISpreadsheet |
Before |
Occurs before detecting the encoding of the loaded CSV or TXT data.
Inherited from ISpreadsheet |
Before |
Occurs before the document is saved (exported to a certain format).
Inherited from ISpreadsheet |
Before |
Occurs before a document is loaded (imported from an external source).
Inherited from ISpreadsheet |
Before |
Occurs before printing a workbook.
Inherited from ISpreadsheet |
Clipboard |
Occurs after data on the Clipboard is obtained and recognized, but before data is actually pasted.
Inherited from ISpreadsheet |
Clipboard |
Occurs after data has been pasted from the Clipboard onto a worksheet.
Inherited from ISpreadsheet |
Clipboard |
Occurs before data is pasted from the Clipboard.
Inherited from ISpreadsheet |
Columns |
Occurs after new columns have been added to a worksheet.
Inherited from ISpreadsheet |
Columns |
Occurs when new columns are about to be inserted into a worksheet.
Inherited from ISpreadsheet |
Columns |
Occurs after columns have been deleted from a worksheet.
Inherited from ISpreadsheet |
Columns |
Occurs when columns are about to be deleted from a worksheet.
Inherited from ISpreadsheet |
Column |
Occurs after the column width was changed.
Inherited from ISpreadsheet |
Comment |
Occurs when a comment is inserted.
Inherited from ISpreadsheet |
Comment |
Occurs before inserting a comment.
Inherited from ISpreadsheet |
Comment |
Occurs when a comment is deleted.
Inherited from ISpreadsheet |
Comment |
Occurs before deleting a comment.
Inherited from ISpreadsheet |
Copied |
Occurs after the range content has been pasted into target cells.
Inherited from ISpreadsheet |
Copied |
Occurs before the range content is pasted into target cells.
Inherited from ISpreadsheet |
Custom |
Occurs before a custom assembly is loaded for use as the Entity Framework data source during mail merge and allows you to cancel loading.
Inherited from ISpreadsheet |
Defined |
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 ISpreadsheet |
Document |
Occurs when a document that has not yet been saved is about to be closed.
Inherited from ISpreadsheet |
Document |
Occurs after a document is loaded.
Inherited from ISpreadsheet |
Document |
Occurs after a document has been saved.
Inherited from ISpreadsheet |
Empty |
Occurs when a new document is created.
Inherited from ISpreadsheet |
Encrypted |
Raises when the encrypted file did not pass the data integrity verification.
Inherited from ISpreadsheet |
Encrypted |
Occurs when the encryption password is empty or invalid.
Inherited from ISpreadsheet |
Encrypted |
Raises when the Workbook |
Initialize |
Occurs before a document is loaded. Handle this event to set initial document settings.
Inherited from ISpreadsheet |
Invalid |
Fires when the supplied data could not be recognized as data in the assumed format for import.
Inherited from ISpreadsheet |
Modified |
Occurs when the value of the ISpreadsheet |
Panes |
Occurs after a worksheet area has been frozen.
Inherited from ISpreadsheet |
Panes |
Occurs after a frozen worksheet area has been unlocked.
Inherited from ISpreadsheet |
Range |
Occurs after the range content has been copied.
Inherited from ISpreadsheet |
Range |
Occurs before a cell range is copied in a worksheet.
Inherited from ISpreadsheet |
Row |
Occurs after the row height was changed.
Inherited from ISpreadsheet |
Rows |
Occurs after new rows have been added to a worksheet.
Inherited from ISpreadsheet |
Rows |
Occurs when new rows are about to be inserted into a worksheet.
Inherited from ISpreadsheet |
Rows |
Occurs after rows have been deleted from a worksheet.
Inherited from ISpreadsheet |
Rows |
Occurs when rows are about to be deleted from a worksheet.
Inherited from ISpreadsheet |
Schema |
Occurs when the schema of an external workbook is changed (a new worksheet is added, a new defined name appears etc.).
Inherited from External |
Scroll |
Occurs when the scroll position changes in a worksheet.
Inherited from ISpreadsheet |
Selection |
Fires in response to changing cell selection in a worksheet.
Inherited from ISpreadsheet |
Shape |
Occurs after a drawing object has been inserted into a worksheet.
Inherited from ISpreadsheet |
Shape |
Occurs after a drawing object has been removed from a worksheet.
Inherited from ISpreadsheet |
Shape |
Occurs before a drawing object is removed from a worksheet.
Inherited from ISpreadsheet |
Shapes |
Occurs before a drawing object is copied in a worksheet.
Inherited from ISpreadsheet |
Sheet |
Occurs after a new worksheet has been added to a workbook.
Inherited from ISpreadsheet |
Sheet |
Occurs after a worksheet has been removed from a workbook.
Inherited from ISpreadsheet |
Sheet |
Occurs when a worksheet is about to be removed from a workbook.
Inherited from ISpreadsheet |
Sheet |
Occurs after a worksheet has been renamed.
Inherited from ISpreadsheet |
Sheet |
Occurs when a worksheet is about to be renamed.
Inherited from ISpreadsheet |
Unit |
Fires after a unit of measurement used in the workbook is changed.
Inherited from ISpreadsheet |
Unit |
Fires before a unit of measurement used within the workbook is changed.
Inherited from ISpreadsheet |
See Also