- 5 minutes to read
using DevExpress.Spreadsheet; // ... // Access a workbook. IWorkbook workbook = spreadsheetControl.Document;
Worksheets and Chart Sheets
A workbook consists of one or more worksheets stored in the IWorkbook.Worksheets collection. When you create a SpreadsheetControl instance, it contains a workbook with an empty worksheet. Use the WorksheetCollection members to add a new worksheet, remove an existing worksheet, rename a worksheet, select an active worksheet, and so on.
The IWorkbook.Sheets collection stores all sheets (worksheets and chart sheets) in a workbook. Use this collection to obtain a sheet of any type.
Built-in and Custom Functions
You can include functions in your formulas to perform calculations. Use the IWorkbook.Functions property to access the WorkbookFunctions object that stores all built-in functions and allows you to override any function via the WorkbookFunctions.OverrideFunction method.
You can also create a custom function. To add a custom function to a workbook, define a class that implements the ICustomFunction interface and add its instance to the IWorkbook.CustomFunctions or IWorkbook.GlobalCustomFunctions collection.
Custom functions are not saved. To replace custom function definitions with calculated values when a workbook is saved, set the WorkbookExportOptions.CustomFunctionExportMode option to CalculatedValue.
Table and Pivot Table Styles
The IWorkbook.TableStyles collection stores styles you can apply to tables and pivot tables. You can select a built-in style or create a custom style.
Custom XML Parts
You can embed arbitrary XML data in workbooks in Excel file formats. This data is named custom XML part and stored in the IWorkbook.CustomXmlParts collection. Use the collection’s members to create and modify custom XML parts.
Operations with Workbooks
The following table lists operations you can perform on a workbook. The commands listed below are also available in the Ribbon UI.
Create a new workbook
Load a workbook
Save a workbook
Protect a workbook
Encrypt a workbook
Print a workbook
Undo or redo an action
View and edit document properties
Use the SpreadsheetControl.Options or IWorkbook.Options property to get access to various document options. They include:
Specifies options used to import documents in different file formats.
Specifies options used to export documents to different file formats.
Defines the file name and file format used when a workbook is saved.
Specifies options for worksheet cells.
Contains options that allow you to control copy operations.
Contains options for clipboard operations.
Provides access to the WorkbookEventOptions.RaiseOnModificationsViaAPI option that enables you to raise the SpreadsheetControl’s events for changes performed via the API.
Provides culture-specific settings.
Specifies the calculation mode for the Spreadsheet control.
Specifies the computational model used to perform calculations in a workbook.
Provides access to options for real-time data (RTD) function calculation.
Provides access to the SpreadsheetDataSourceLoadingOptions.CustomAssemblyBehavior option that specifies whether to load a custom assembly with the Entity Framework data context during mail merge.
Provides access to the following compatibility settings:
Specifies whether to apply the WorksheetView.Zoom setting to all worksheet views or the current view only.
Other workbook settings are available from the IWorkbook.DocumentSettings property.
Provides access to formula calculation options.
Specifies whether a workbook should use the R1C1 reference style.
Provides access to document encryption options.
Specifies whether to show Field List for pivot tables in a workbook.
Appends all worksheets from the specified workbooks to the current workbook.
Creates a workbook’s copy.
To enable workbook extensions, add a reference to the DevExpress.Docs.v21.1.dll library and import the DevExpress.Spreadsheet namespace into your code with a using directive (Imports in Visual Basic).