ITabbedViewController.CreateNewDocumentGroup(Document, Orientation, Int32) Method

Creates a new group that will display the specified document. The group will be added at the specified position among other groups. The method allows you to change the orientation of document groups within a TabbedView.

Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

bool CreateNewDocumentGroup(
    Document document,
    Orientation orientation,
    int insertIndex
)
Function CreateNewDocumentGroup(
    document As Document,
    orientation As Orientation,
    insertIndex As Integer
) As Boolean

Parameters

Name Type Description
document Document

A Document to be displayed in the newly created group.

orientation Orientation

An Orientation value that is assigned to the View's TabbedView.Orientation property.

insertIndex Int32

A zero-based index at which the new document group is added among other document groups.

Returns

Type Description
Boolean

true, if the operation was successful; otherwise, false.

Remarks

This method creates a new group and displays the specified document in this group. A group is added to the TabbedView.DocumentGroups collection at the position specified by the insertIndex parameter. See the TabbedView.DocumentGroups link to learn more.

NOTE

In default layout mode, where groups are aligned either vertically or horizontally, the insertIndex parameter can be used not only to set the group position within the TabbedView.DocumentGroups collection, but also to specify the location of this group at runtime. When Free Layout Mode is on, the insertIndex parameter specifies this group's position within the root docking container. In this case, this index does not necessarily reflect the group's location on screen.

To add more documents to a group, use the ITabbedViewController.Dock method.

See Also