TabbedView Class

Presents MDI child windows as a tabbed UI.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v18.1.dll

Declaration

C#

public class TabbedView :
    BaseView,
    IThumbnailViewClient,
    IFreeLayoutView,
    ISupportBatchUpdate

VB.NET

Public Class TabbedView
    Inherits BaseView
    Implements IThumbnailViewClient,
               IFreeLayoutView,
               ISupportBatchUpdate

Remarks

MDI child windows can be presented by a DocumentManager either as a native MDI or tabbed UI. To use the tabbed UI, create a TabbedView object and assign it to the DocumentManager.View property. To enable a native MDI, create a NativeMdiView object and assign it to the DocumentManager.View property.

Documents in a TabbedView are displayed as tabs. You can split the View’s area vertically or horizontally into document groups. In code, you can create a new group via the ITabbedViewController.CreateNewDocumentGroup method accessible via the View’s Controller object. An end-user can split the area via a document’s context menu or drag-and-drop.

When you do not create extra groups, there is one default group that displays all documents. When document groups are created, they are added to the TabbedView.DocumentGroups collection.

The number of documents displayed simultaneously in a group can be limited via the IDocumentGroupProperties.MaxDocuments and IDocumentGroupDefaultProperties.MaxDocuments properties.

Example

This example shows how to enable a tabbed UI for a DocumentManager where MDI child windows are presented as tab pages.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-enable-tabbed-ui-in-document-manager-e3245

Form1.cs

using System;
using System.Windows.Forms;
using DevExpress.XtraBars.Docking2010;
using DevExpress.XtraBars.Docking2010.Views.Tabbed;
using DevExpress.XtraEditors;

namespace DocumentManager_TabbedUI {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }
        void Form1_Load(object sender, EventArgs e) {
            AddDocumentManager();
            for(int i = 0; i < 3; i++) {
                AddChildForm();
            }
        }
        void AddDocumentManager() {
            DocumentManager manager = new DocumentManager();
            manager.MdiParent = this;
            manager.View = new TabbedView();
        }
        int count;
        void AddChildForm() {
            Form childForm = new Form();
            childForm.Text = "Child Form " + (++count).ToString();

            SimpleButton btn = new SimpleButton();
            btn.Text = "Button " + count.ToString();
            btn.Parent = childForm;

            childForm.MdiParent = this;
            childForm.Show();
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraBars.Docking2010
Imports DevExpress.XtraBars.Docking2010.Views.Tabbed
Imports DevExpress.XtraEditors

Namespace DocumentManager_TabbedUI
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
        End Sub
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            AddDocumentManager()
            For i As Integer = 0 To 2
                AddChildForm()
            Next i
        End Sub
        Private Sub AddDocumentManager()
            Dim manager As New DocumentManager()
            manager.MdiParent = Me
            manager.View = New TabbedView()
        End Sub
        Private count As Integer
        Private Sub AddChildForm()
            Dim childForm As New Form()
            count += 1
            childForm.Text = "Child Form " & (count).ToString()

            Dim btn As New SimpleButton()
            btn.Text = "Button " & count.ToString()
            btn.Parent = childForm

            childForm.MdiParent = Me
            childForm.Show()
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the TabbedView 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#

XAF_how-to-access-the-documentmanager-barmanager-and-ribboncontrol-e4027/CS/TabsLayoutCustomization.Module.Win/Controllers/TabsCustomizationWindowController.cs#L29

private static void CustomizeDocumentManagerView(BaseView view) {
    if(view is TabbedView) {
        ((TabbedView)view).DocumentGroupProperties.HeaderLocation = DevExpress.XtraTab.TabHeaderLocation.Left;

tabbedview-how-to-convert-the-default-layout-to-a-table-one-t323423/CS/FreeLayoutModeExample/ExampleHelper.cs#L13

{
    public ExampleHelper(TabbedView _TabbedView)
    {

how-to-enable-tabbed-ui-in-document-manager-e3245/CS/DocumentManager_TabbedUI/Form1.cs#L21

    manager.MdiParent = this;
    manager.View = new TabbedView();
}

VB.NET

XAF_how-to-access-the-documentmanager-barmanager-and-ribboncontrol-e4027/VB/TabsLayoutCustomization.Module.Win/Controllers/TabsCustomizationWindowController.vb#L31

Private Shared Sub CustomizeDocumentManagerView(ByVal view As BaseView)
    If TypeOf view Is TabbedView Then
        CType(view, TabbedView).DocumentGroupProperties.HeaderLocation = DevExpress.XtraTab.TabHeaderLocation.Left

tabbedview-how-to-convert-the-default-layout-to-a-table-one-t323423/VB/FreeLayoutModeExample/ExampleHelper.vb#L11

Public Class ExampleHelper
    Public Sub New(ByVal _TabbedView As TabbedView)
        tabbedView = _TabbedView

how-to-enable-tabbed-ui-in-document-manager-e3245/VB/DocumentManager_TabbedUI/Form1.vb#L23

    manager.MdiParent = Me
    manager.View = New TabbedView()
End Sub

Inheritance

Object

MarshalByRefObject

Component

BaseComponent

BaseView

TabbedView