BaseView.DocumentClosing Event

Fires when a document is about to be closed.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

public event DocumentCancelEventHandler DocumentClosing

VB.NET

Public Event DocumentClosing As DocumentCancelEventHandler

Event Data

The DocumentClosing event's data class is DocumentCancelEventArgs. The following properties provide information specific to this event:

Property	Description
Cancel	Gets or sets a value indicating whether the event should be canceled. Inherited from CancelEventArgs.
Document	The Document related to the current event.

Remarks

You can handle the DocumentClosing event to prevent a document from being closed. This can be accomplished by setting the event’s Cancel parameter to true.

When a document is closed, it is destroyed. After the document has been closed, the BaseView.DocumentClosed event fires. This event serves for notifications only.

To temporarily hide a document, use the BaseView.RemoveDocument or IBaseViewController.RemoveDocument method. The IBaseViewController.RemoveDocument method is accessible via the View’s Controller property (TabbedView.Controller or NativeMdiView.Controller).

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DocumentClosing event.

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#

customdocumentshostwindow-how-to-create-your-own-floating-document-container-t184832/CS/T184832/Form1.cs#L39

floatDocHost.ContainerControl = this;
floatDocHost.View.DocumentClosing += View_DocumentClosing;
floatDocHost.View.FloatingDocumentContainer = DevExpress.XtraBars.Docking2010.Views.FloatingDocumentContainer.DocumentsHost;

VB.NET

customdocumentshostwindow-how-to-create-your-own-floating-document-container-t184832/VB/T184832/Form1.vb#L43

floatDocHost.ContainerControl = Me
AddHandler floatDocHost.View.DocumentClosing, AddressOf View_DocumentClosing
floatDocHost.View.FloatingDocumentContainer = DevExpress.XtraBars.Docking2010.Views.FloatingDocumentContainer.DocumentsHost