DockPanel.DockAsMdiDocument(Boolean) Method

Docks the panel to a DocumentManager located in the same form as the current DockManager and optionally activates this panel.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public bool DockAsMdiDocument(
    bool activate
)

VB.NET

Public Function DockAsMdiDocument(
    activate As Boolean
) As Boolean

Parameters

Name	Type	Description
activate	Boolean	true, to activate the docked panel; otherwise, false.

Returns

Type	Description
Boolean	true if the operation has completed successfully; otherwise, false.

Remarks

The DockAsMdiDocument method is equivalent to the IBaseViewController.Dock method. The method is not supported when docking a DockPanel to NativeMdiView objects.

When a panel is docked to a DocumentManager, it becomes a document belonging to this DocumentManager. To work with panels transformed into documents, use the methods provided by the TabbedView.Controller object. The document that corresponds to a dock panel can be accessed with the DocumentManager.GetDocument method.

This example docks and undocks the MDI dockPanel1:

C#

void simpleButton1_Click(object sender, EventArgs e) {
    if (documentManager1.GetDocument(dockPanel1) != null) {
        tabbedView1.Controller.Float(dockPanel1);
        simpleButton1.Text = "Dock as MDI";
    }
    else {
        dockPanel1.DockAsMdiDocument(true);
        simpleButton1.Text = "Undock/Float";
    }
}

VB.NET

Private Sub simpleButton1_Click(ByVal sender As Object, ByVal e As EventArgs)
    If documentManager1.GetDocument(dockPanel1) IsNot Nothing Then
        tabbedView1.Controller.Float(dockPanel1)
        simpleButton1.Text = "Dock as MDI"
    Else
        dockPanel1.DockAsMdiDocument(True)
        simpleButton1.Text = "Undock/Float"
    End If
End Sub