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


In This Topic
    AllowAutoHide Property
    In This Topic
    Gets 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.
    Syntax
    'Declaration
     
    <DescriptionAttribute("Indicates if docked ToolWindows can become auto-hide ToolWindows and if auto-hide ToolWindows can become docked ToolWindows.")>
    <CategoryAttribute("Behavior")>
    Public Property AllowAutoHide As Boolean
    'Usage
     
    Dim instance As DockLayoutManager
    Dim value As Boolean
     
    instance.AllowAutoHide = value
     
    value = instance.AllowAutoHide
    [Description("Indicates if docked ToolWindows can become auto-hide ToolWindows and if auto-hide ToolWindows can become docked ToolWindows.")]
    [Category("Behavior")]
    public bool AllowAutoHide {get; set;}

    Property Value

    true if docked ToolWindows can become auto hide ToolWindows and auto hide ToolWindows can become docked ToolWindows; false otherwise. By default, true.
    Remarks

    Each ToolWindow can be "pinned" or "unpinned". If a ToolWindow is unpinned, it will automatically hide when it no longer has the mouse and its associated tab will be displayed in the AutoHideFrameAppearance. To reopen the ToolWindow, the mouse must be placed over the tab. At any time, a ToolWindow can be pinned or unpinned by clicking on the "pin/unpin" glyph in the caption unless the AllowAutoHide property is set to false. Only a docked ToolWindow can be unpinned (state changed to ToolWindowState.AutoHide) or pinned (state changed to ToolWindowState).Docked.

    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 AllowAutoHide property to its default value, the ResetAllowAutoHide 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