SpreadsheetControl.CreateNewDocument() Method

Creates and loads a new empty workbook.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v19.2.dll

Declaration

C#

public bool CreateNewDocument()

VB.NET

Public 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 SpreadsheetControl.Modified property is true), the CreateNewDocument method call raises the SpreadsheetControl.DocumentClosing event.

Set e.Cancel to true in the SpreadsheetControl.DocumentClosing event handler to prevent a document from closing. In this case, the CreateNewDocument method returns 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.

C#

udf-custom-function-a-sample-custom-function-that-returns-an-array-t538369/CS/CustomFunctionReturningArrayExample/Form1.cs#L19

private void Form1_Load(object sender, EventArgs e) {
    spreadsheetControl1.CreateNewDocument();
    spreadsheetControl1.ActiveWorksheet.Range["$A$1:$E$2"].FillColor = Color.Honeydew;

winforms-spreadsheetcontrol-api-part-3-t231273/CS/SpreadsheetControl_API_Part03/Form1.cs#L373

codeEditor.BeforeCompile();
spreadsheetControl.CreateNewDocument();
document.Unit = DevExpress.Office.DocumentUnit.Document;

VB.NET

udf-custom-function-a-sample-custom-function-that-returns-an-array-t538369/VB/CustomFunctionReturningArrayExample/Form1.vb#L21

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
    spreadsheetControl1.CreateNewDocument()
    spreadsheetControl1.ActiveWorksheet.Range("$A$1:$E$2").FillColor = Color.Honeydew

winforms-spreadsheetcontrol-api-part-3-t231273/VB/SpreadsheetControl_API_Part03/Form1.vb#L362

codeEditor.BeforeCompile()
spreadsheetControl.CreateNewDocument()
document.Unit = DevExpress.Office.DocumentUnit.Document