Workbook.CreateNewDocument() Method
Creates and loads a new empty workbook.
You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this property in production code.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Docs.v24.1.dll
NuGet Package: DevExpress.Document.Processor
Declaration
Returns
Type | Description |
---|---|
Boolean | true, if the document is created successfully; otherwise, false. |
Remarks
If the WorkbookEventOptions.RaiseOnModificationsViaAPI property is set to true and the document has unsaved changes (the Workbook.Modified property is true), using the CreateNewDocument method will raise the Workbook.DocumentClosing event.
By handling the Workbook.DocumentClosing event, you can set e.Cancel to true to prevent a document from closing. In this case, the CreateNewDocument method will return false.
If the new document was created and successfully loaded, the CreateNewDocument method returns true.
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateNewDocument() 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.