RichEditControl.CreateNewDocument(Boolean) Method

Creates and loads a new empty document. Optionally, raises the DocumentClosing event.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.1.dll

Declaration

public virtual bool CreateNewDocument(
    bool raiseDocumentClosing = false
)
Public Overridable Function CreateNewDocument(
    raiseDocumentClosing As Boolean = False
) As Boolean

Optional Parameters

Name Type Default Description
raiseDocumentClosing Boolean

False

true, to raise the RichEditControl.DocumentClosing event; otherwise, false.

Returns

Type Description
Boolean

true, if a new document is created and loaded; otherwise, false.

Remarks

The CreateNewDocument helps prevent users from losing unsaved changes when a new document is created.

If the raiseDocumentClosing parameter is set to true and the RichEditControl's document has unsaved changes (the RichEditControl.Modified property is true), the RichEditControl.DocumentClosing event is fired.

By handling the DocumentClosing event, you can set e.Cancel to true to cancel unloading a document. A new document will not be created and the CreateNewDocument method returns false.

If the new document was created and successfully loaded, the CreateNewDocument method returns true.

Examples

The following code creates a new empty document with default formatting.

The RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

static void buttonCustomAction_ItemClick_NewDocument(object sender, ItemClickEventArgs e) {
    RichEditControl richEdit = e.Item.Tag as RichEditControl;
    richEdit.CreateNewDocument();
}
See Also