BaseView.ActiveDocument Property

Gets the active document.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

[Browsable(false)]
public BaseDocument ActiveDocument { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property ActiveDocument As BaseDocument

Property Value

Type	Description
BaseDocument	A BaseDocument object that is the active document.

Remarks

To activate a specific document, use the BaseView.ActivateDocument or IBaseViewController.Activate method. The IBaseViewController.Activate method is accessible via a View’s Controller property (NativeMdiView.Controller or TabbedView.Controller).

When a document is activated, the BaseView.DocumentActivated event fires. To access the current active document, use the BaseView.ActiveDocument property.

Related GitHub Examples

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

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#

how-to-merge-bars-within-the-documentmanager-control-e4950/CS/DocumentManagerBarMerging/Form1.cs#L25

private void Dock(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
    if (tabbedView1.ActiveDocument != null) tabbedView1.Controller.Float(tabbedView1.ActiveDocument);
}

VB.NET

how-to-merge-bars-within-the-documentmanager-control-e4950/VB/DocumentManagerBarMerging/Form1.vb#L26

Private Overloads Sub Dock(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs) Handles barButtonItem1.ItemClick
    If tabbedView1.ActiveDocument IsNot Nothing Then
        tabbedView1.Controller.Float(tabbedView1.ActiveDocument)