IWidgetViewController.Dock(Document, Document, Orientation, Int32) Method

Docks one widget to another according to the given orientation value.

Namespace: DevExpress.XtraBars.Docking2010.Views.Widget

Assembly: DevExpress.XtraBars.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

bool Dock(
    Document sourceDocument,
    Document targetDocument,
    Orientation orientation,
    int index
)

VB.NET

Function Dock(
    sourceDocument As Document,
    targetDocument As Document,
    orientation As Orientation,
    index As Integer
) As Boolean

Parameters

Name	Type	Description
sourceDocument	Document	A Document that is the widget that needs to be docked.
targetDocument	Document	A Document that is the widget next to which the sourceDocument widget will be docked.
orientation	Orientation	An Orientation enumerator value that specifies whether these two widgets will be aligned horizontally or vertically.
index	Int32	An Int32 value that specifies the docked widget’s position.

Returns

Type	Description
Boolean	true if a widget is successfully docked; otherwise, false.