Xceed Logo
Shop
Xceed Docking Windows for WinForms v2.3 Documentation
Xceed.DockingWindows Namespace / DockLayoutManager Class
Members


In This Topic
    DockLayoutManager Class
    In This Topic
    The DockLayoutManager manages the interaction of its associated ToolWindows in and around the defined host areas (DockHost and ClientHost) as well as in relation to each other.
    Syntax
    'Declaration
 
<DesignerAttribute("Xceed.DockingWindows.Design.DockLayoutManagerDesigner,Xceed.DockingWindows.v2.3.Design,Version=2.3.25454.6275,Culture=neutral,PublicKeyToken=ba83ff368b7563c6")>
<DesignerSerializerAttribute("Xceed.DockingWindows.Design.DockLayoutManagerSerializer,Xceed.DockingWindows.v2.3.Design,Version=2.3.25454.6275,Culture=neutral,PublicKeyToken=ba83ff368b7563c6", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")>
<ToolboxBitmapAttribute(Xceed.DockingWindows.DockLayoutManager)>
<DesignerCategoryAttribute("Component")>
Public NotInheritable Class DockLayoutManager 
   Inherits System.ComponentModel.Component
    'Usage
 
Dim instance As DockLayoutManager
    [Designer("Xceed.DockingWindows.Design.DockLayoutManagerDesigner,Xceed.DockingWindows.v2.3.Design,Version=2.3.25454.6275,Culture=neutral,PublicKeyToken=ba83ff368b7563c6")]
[DesignerSerializer("Xceed.DockingWindows.Design.DockLayoutManagerSerializer,Xceed.DockingWindows.v2.3.Design,Version=2.3.25454.6275,Culture=neutral,PublicKeyToken=ba83ff368b7563c6", "System.ComponentModel.Design.Serialization.CodeDomSerializer, System.Design, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")]
[ToolboxBitmap(Xceed.DockingWindows.DockLayoutManager)]
[DesignerCategory("Component")]
public sealed class DockLayoutManager : System.ComponentModel.Component
    Remarks

    Through the DockLayoutManager, end-user interaction with ToolWindows can be partially or completely restricted, and their size, location, visibility, and state can be saved and loaded.

    Inheritance Hierarchy

    System.Object
       System.MarshalByRefObject
          System.ComponentModel.Component
             Xceed.DockingWindows.DockLayoutManager

    Public Constructors
     NameDescription
    Public ConstructorDockLayoutManager ConstructorInitializes a new instance of the DockLayoutManager class specify the DockHost and ClientHost.  
    Top
    Public Properties
     NameDescription
    Public PropertyActiveToolWindowGets the active ToolWindow.  
    Public PropertyAllowAutoHideGets or sets a boolean value indicating whether docked ToolWindows can become auto hide ToolWindows and whether auto hide ToolWindows can become docked ToolWindows, by displaying or removing the auto hide "pin/unpin" glyph and the "Auto Hide" option from the context menu.  
    Public PropertyAllowDockingGets or sets a boolean value indicating whether floating ToolWindows can become docked, as well as preventing currently docked ToolWindows from being docked in another location.  
    Public PropertyAllowFloatingGets or sets a boolean value indicating whether docked ToolWindows can become floating.  
    Public PropertyAllowHideGets or sets a boolean value indicating whether ToolWindows can be hidden by displaying or removing the hide glyph and the "Hide" option from the context menu.  
    Public PropertyAutoHideFrameAppearanceGets the appearance of the AutoHideFrame in which the tabs of auto hide ToolWindows are displayed.  
    Public PropertyCaptionAppearanceGets or sets the appearance of the docked ToolWindows' captions.  
    Public PropertyClientHostGets the control around which ToolWindows can be docked.  
    Public PropertyContainer (Inherited from System.ComponentModel.Component)
    Public PropertyDockHostGets the control in which ToolWindows can be docked.  
    Public PropertyShowMenuOnCtrlTabGets or sets a value indicating if the tool window/Mdi child-selection menu is displayed when the CTRL and TAB buttons are pressed.  
    Public PropertySite (Inherited from System.ComponentModel.Component)
    Public PropertyStyleGets or sets the style with which the ToolWindow tabs and dock-hints are drawn.  
    Public PropertyTabStripAppearanceGets the appearance of the tabstrips when ToolWindows are grouped.  
    Public PropertyToolWindowsGets a list of the ToolWindows managed by the DockLayoutManager.  
    Top
    Protected Properties
     NameDescription
    Protected PropertyCanRaiseEvents (Inherited from System.ComponentModel.Component)
    Protected PropertyDesignMode (Inherited from System.ComponentModel.Component)
    Protected PropertyEvents (Inherited from System.ComponentModel.Component)
    Top
    Public Methods
     NameDescription
    Public MethodCreateObjRef (Inherited from System.MarshalByRefObject)
    Public MethodDisposeOverloaded. Overridden. Clean up any resources being used.  
    Public MethodGetLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodInitializeLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodLoadLayoutOverloaded. Loads the layout from the specified location.  
    Public MethodResetAllowAutoHideResets the value of the AllowAutoHide property to its default value, true.  
    Public MethodResetAllowDockingResets the value of the AllowDocking property to its default value, true.  
    Public MethodResetAllowFloatingResets the value of the AllowFloating property to its default value, true.  
    Public MethodResetAllowHideResets the value of the AllowHide property to its default value, true.  
    Public MethodResetStyle  
    Public MethodResumeLayoutResumes normal layout logic following a call to the is called.  
    Public MethodToString (Inherited from System.ComponentModel.Component)
    Top
    Protected Methods
     NameDescription
    Protected MethodFinalize (Inherited from System.ComponentModel.Component)
    Protected MethodGetService (Inherited from System.ComponentModel.Component)
    Protected MethodMemberwiseCloneOverloaded.  (Inherited from System.MarshalByRefObject)
    Top
    Public Events
     NameDescription
    Public EventActiveToolWindowChangedRaised when the value of the ActiveToolWindow property is changed.  
    Public EventAllowAutoHideChangedRaised when the value of the AllowAutoHide property is changed.  
    Public EventAllowDockingChangedRaised when the value of the AllowDocking property is changed.  
    Public EventAllowFloatingChangedRaised when the value of the AllowFloating property is changed.  
    Public EventAllowHideChangedRaised when the value of the AllowHide property is changed.  
    Public EventDisposed (Inherited from System.ComponentModel.Component)
    Public EventStyleChangedRaised when the value of the Style property is changed.  
    Top
    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

    Reference

    DockLayoutManager Members
    Xceed.DockingWindows Namespace

    Send Feedback