DocumentGroup Class

A group of Documents within a TabbedView.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

public class DocumentGroup :
    BaseComponent,
    IFreeLayoutElement,
    IBaseObject,
    IDisposable
Public Class DocumentGroup
    Inherits BaseComponent
    Implements IFreeLayoutElement,
               IBaseObject,
               IDisposable

Related API Members

The following members accept/return DocumentGroup objects:

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.

See Also