ITabbedViewController.Dock(Document, DocumentGroup, Int32) Method
Docks the specified document to the specified group at a specific position.
Namespace: DevExpress.XtraBars.Docking2010.Views.Tabbed
Assembly: DevExpress.XtraBars.v24.2.dll
NuGet Package: DevExpress.Win.Navigation
#Declaration
bool Dock(
Document document,
DocumentGroup group,
int insertIndex
)
#Parameters
Name | Type | Description |
---|---|---|
document | Document | A Document object to be docked. |
group | Document |
A Document |
insert |
Int32 | An integer value that specifies the index at which the document will be docked. The visual order of documents within a group is specified by the |
#Returns
Type | Description |
---|---|
Boolean | true if the operation was a success; otherwise, false. |
#Remarks
You can limit the number of items (documents and dock panels) displayed simultaneously within a group via the IDocumentGroupDefaultProperties.MaxDocuments/IDocumentGroupProperties.MaxDocuments properties. If a group is displaying the maximum number of items (MaxDocuments), and you try to dock a new item to this group via the Dock method, the operation will not be successful.