.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+
Row

ISpreadsheetComponent.CreateNewDocument() Method

Creates and loads a new empty workbook.

Namespace: DevExpress.Spreadsheet

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

Declaration

bool CreateNewDocument()
Function CreateNewDocument As Boolean
bool CreateNewDocument()
Function CreateNewDocument As Boolean
bool CreateNewDocument()
Function CreateNewDocument As Boolean

Returns

Type Description
Boolean

true, if the document is created successfully; otherwise, false.

Returns

Type Description
Boolean

true, if the document is created successfully; otherwise, false.

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.

See Also