IXlDocument.CreateSheet() Method
Creates a new worksheet in the workbook and returns the IXlSheet object.
Namespace: DevExpress.Export.Xl
Assembly: DevExpress.Printing.v24.1.Core.dll
NuGet Package: DevExpress.Printing.Core
Declaration
Returns
| Type | Description |
|---|---|
| IXlSheet | An IXlSheet object that is the newly created worksheet. |
Remarks
Note
When you finish working with the IXlSheet object, call the Dispose method to release all the resources used by the object. Otherwise, generated content is not written to the output file. You can also modify the IXlSheet object within the using statement (Using block in Visual Basic).
Example
The example below demonstrates how to add a worksheet to a workbook. To do this, use the IXlDocument.CreateSheet method.
To specify a worksheet name, use the IXlSheet.Name property. When naming a worksheet, take into account the constraints listed in the How to: Set a Worksheet Name document. If you do not specify a worksheet name, the default name “SheetN” is used, where N is a sequential number of a worksheet within a workbook.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/excel-export-api-examples
// Create a new document.
using (IXlDocument document = exporter.CreateDocument(stream)) {
// Specify the document culture.
document.Options.Culture = CultureInfo.CurrentCulture;
// Create a new worksheet under the specified name.
using (IXlSheet sheet = document.CreateSheet()) {
sheet.Name = "Sales report";
}
}
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateSheet() method.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.