Xceed Docking Windows for WinForms v2.3 Documentation
Xceed.DockingWindows Namespace / DockLayoutManager Class / ClientHost Property


In This Topic
    ClientHost Property
    In This Topic
    Gets the control around which ToolWindows can be docked.
    Syntax
    'Declaration
     
    Public ReadOnly Property ClientHost As Control
    'Usage
     
    Dim instance As DockLayoutManager
    Dim value As Control
     
    value = instance.ClientHost
    public Control ClientHost {get;}

    Property Value

    A System.Windows.Forms.Control representing the control around which ToolWindow can be docked. Can be a null reference (Nothing in Visual Basic).
    Remarks

    In an SDI application, the DockHost is the control in which the ToolWindows can be docked while the ClientHost, which must be a child of the DockHost and is optional, is the control around which ToolWindows can be docked (work area). The ClientHost will always be docked in the DockHost and will occupy the space not occupied by ToolWindows. This means that if no ToolWindows are contained in the DockHost, the ClientHost will occupy all of the space in the DockHost. In an Mdi application, the ClientHost will always be the Mdi client (where the Mdi children are located) of the Mdi container (DockHost). Any control assigned as the ClientHost will be ignored.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also