DocumentCancelEventArgs Class

Provides data for the BaseView.DocumentClosing event.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v18.1.dll

Declaration

C#

public class DocumentCancelEventArgs :
    CancelEventArgs

VB.NET

Public Class DocumentCancelEventArgs
    Inherits CancelEventArgs

Related API Members

DocumentCancelEventArgs is the data class for the following events:

• BaseView.BeginDocking
• BaseView.BeginDocumentsHostDocking
• BaseView.BeginFloating
• BaseView.DocumentClosing
• DocumentGroup.TabMouseActivating
• TabbedView.TabMouseActivating

Remarks

The BaseView.DocumentClosing event occurs when a document is about to be closed. The DocumentCancelEventArgs class provides data for this event.

Related GitHub Examples

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

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#L43

void View_DocumentClosing(object sender, DevExpress.XtraBars.Docking2010.Views.DocumentCancelEventArgs e) {
    //do something

VB.NET

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

Private Sub View_DocumentClosing(ByVal sender As Object, ByVal e As DevExpress.XtraBars.Docking2010.Views.DocumentCancelEventArgs)
    'do something

Inheritance

Object

EventArgs

CancelEventArgs

DocumentCancelEventArgs

ControlReleasingEventArgs