SpreadsheetControl.CreateNewDocument() Method

Creates and loads a new empty workbook.

Namespace: DevExpress.Xpf.Spreadsheet

Assembly: DevExpress.Xpf.Spreadsheet.v20.1.dll

Declaration

public bool CreateNewDocument()
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), using the CreateNewDocument method will raise the SpreadsheetControl.DocumentClosing event.

By handling the SpreadsheetControl.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.

Implements

See Also