ISpreadsheetComponent.CreateNewDocument() Method

Creates and loads a new empty workbook.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v23.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

bool CreateNewDocument()

VB.NET

Function CreateNewDocument As Boolean

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 SpreadsheetControl’s document has unsaved changes (the ISpreadsheetComponent.Modified property is true), using the CreateNewDocument method will raise the ISpreadsheetComponent.DocumentClosing event.

By handling the ISpreadsheetComponent.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 snippet (auto-collected from DevExpress Examples) contains a reference 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.

VB.NET

winforms-spreadsheet-load-an-ms-access-database-file-into-the-document/VB/WindowsFormsApplication1/MSAccessImportHelper.vb#L116

workbook.BeginUpdate()
workbook.CreateNewDocument()
' We only want user tables, not system tables