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


In This Topic
    AllowDocking Property
    In This Topic
    Gets 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.
    Syntax
    'Declaration
     
    <DescriptionAttribute("Indicates if floating ToolWindows can become docked, as well as preventing currently docked ToolWindows from being docked in another location. ")>
    <CategoryAttribute("Behavior")>
    Public Property AllowDocking As Boolean
    'Usage
     
    Dim instance As DockLayoutManager
    Dim value As Boolean
     
    instance.AllowDocking = value
     
    value = instance.AllowDocking
    [Description("Indicates if floating ToolWindows can become docked, as well as preventing currently docked ToolWindows from being docked in another location. ")]
    [Category("Behavior")]
    public bool AllowDocking {get; set;}

    Property Value

    true if floating ToolWindows can become docked, as well as preventing currently docked ToolWindows from being docked in another location; false otherwise. By default, true.
    Remarks

    The AllowDocking property does not change the current state of ToolWindows (i.e.,. docked ToolWindows will remain docked even if AllowDocking is set to false).

    This property only applies to end-user interactivity with ToolWindows; it does not prevent the state or visibility of ToolWindows from being changed programmatically.

    To reset the value of the AllowDocking property to its default value, the ResetAllowDocking method must be called.

    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