DocumentGroup Class

A group of Documents within a TabbedView.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v18.1.dll

Declaration

C#

public class DocumentGroup :
    BaseComponent,
    IFreeLayoutElement,
    IBaseObject,
    IDisposable

VB.NET

Public Class DocumentGroup
    Inherits BaseComponent
    Implements IFreeLayoutElement,
               IBaseObject,
               IDisposable

Related API Members

The following members accept/return DocumentGroup objects:

• Document.Parent

Remarks

A TabbedView always contains a single group to which documents are added by default. It is also possible to add more groups, splitting the available space horizontally or vertically. The TabbedView.Orientation property allows you to specify how groups are arranged - vertically or horizontally. In addition, the group orientation can be changed by using the ITabbedViewController.CreateNewDocumentGroup method that takes an orientation parameter.

To access all groups, use the TabbedView.DocumentGroups collection. To access documents within a group, see DocumentGroup.Items. The ITabbedViewController.Dock method allows you to move a group to a specific document group.

You can customize properties for all document groups via the TabbedView.DocumentGroupProperties object, and then override these settings for individual document groups via the DocumentGroup.Properties object.

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DocumentGroup 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#

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

{
    DocumentGroup tempGroup = null;
    foreach (Document doc in TabbedView.Documents)

VB.NET

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

Private Sub CreateDefaultLayout()
    Dim tempGroup As New DocumentGroup()
    tabbedView.DocumentGroups.Add(tempGroup)

Inheritance

Object

MarshalByRefObject

Component

BaseComponent

DocumentGroup