public class DockingManager : BaseComponent, IDisposable, IThemeProvider, IVisualStyle, IExtenderProvider, ISupportInitialize, IDockingManagerDesignerInvoke, IGetMsgProcListener, ICallWndProcListener

Remarks

The Essential Tools Docking Windows framework enables developers to add docking windows, similar to those found in the Microsoft Visual Studio.NET IDE, to their Windows Forms applications. At the most basic level a docking window may be defined as a control that attaches itself to a host form's border, is capable of being dragged around and docked to different edges within the form and can also be dragged off the host form and floated as an individual top-level window. The docking framework allows just about any child control on a form to be made into a fully qualified docking window. The framework, in addition to the core docking interactions, implements some highly advanced features such as multiple docking levels, nested docking, tabbed docking, tear-off tabs, autohide mode, state persistence etc. To facilitate the addition of these complex features, the DockingManager has a full-fledged WYSIWYG visual designer that enables developers to create the exact docking layout that they desire without having to write a single line of code.

The DockingManager class is the central component of the Essential Tools Docking Windows implementation. The class coordinates and facilitates the multitude of complex interactions that take place between a dockable control and it's host form as well as between the dockable controls themselves. DockingManagers are form-centric and adding an instance of the component to a form makes the form into a 'dock-enabled' host. The DockingManager is implemented as an Extender Provider and upon adding it to a Form or UserControl, the controls that are immediate children of the container qualify for the docking services provided by the docking framework.

The 'EnableDocking' (SetEnableDocking(Control, Boolean)) extended property that the DockingManager adds to controls serves as the trigger for enabling/disabling a control as a dockable window. Upon setting the EnableDocking property, the control is enclosed within a dockable container and will be docked to a default border. The control can now be repositioned by dragging it around within the designer. The DockingManager persists the dock positions set during design time, ie., the dock state information, as a part of the application's resource and uses this persisted info when loading the application. Thus the DockingManager implements a true WYSIWYG visual designer. There is also a simple and intuitive API available for programmatic manipulation of the docking windows.

Examples

The sample code shows how to create and setup a simple docking windows layout constituting of a ListBox control docked to the left side of the form and having a width of 175 units, a second ListBox that is docked as a tab within the first ListBox, a TreeView control that is docked to the form's right border, has a width of 150 units and starts off in the AutoHide mode, and a CheckedListBox control that is initially a floating window.

NOTE: The layout initialization code shown here is required only when docking window is being used programmatically. When using the designer, the layout state will automatically be written to the application's resource file.


	private void InitializeDockingWindows()
	{
		// Create the DockingManager instance and set this form as the host form.
		this.dockingManager = new Syncfusion.Windows.Forms.Tools.DockingManager(this.components);
		this.dockingManager.BeginInit();
		this.dockingManager.HostForm = this;
	// Disable state persistence
	this.dockingManager.PersistState = false;
	// Enable display of the default context menus
	this.dockingManager.EnableContextMenu = true;
	// Set the imagelist that will provide the icons for the docking windows.
	this.dockingManager.ImageList = this.ilDocking;

	// Dock listbox1 to the left border of the form and with an initial
	// width of 175 units.
	// NOTE - Calling DockControl() on a control for the first time,
	// will initialize it as a docking window. This is the equivalent of
	// the DockingManager.SetEnableDocking() call.
	this.dockingManager.DockControl(this.listBox1, this,
		Syncfusion.Windows.Forms.Tools.Syncfusion.Windows.Forms.Tools.DockingStyle.Left, 175);
	// Set the text to be displayed in the dockingwindow caption
	this.dockingManager.SetDockLabel(this.listBox1, &quot;ListBox 1&quot;);
	// The image index used for this control
	this.dockingManager.SetDockIcon(this.listBox1, 0);

	// Now dock listbox2 as a tab onto listbox1
	this.dockingManager.DockControl(this.listBox2, this.listBox1,
		Syncfusion.Windows.Forms.Tools.Syncfusion.Windows.Forms.Tools.DockingStyle.Tabbed, 175);
	this.dockingManager.SetDockLabel(this.listBox2, &quot;ListBox 2&quot;);
	this.dockingManager.SetDockIcon(this.listBox2, 1);

	// Dock the treeView to the right border of the form with a width of 150.
	this.dockingManager.DockControl(this.treeView1, this, Syncfusion.Windows.Forms.Tools.DockingStyle.Right, 150);
	// Set treeView1 to start off in the AutoHide position.
	this.dockingManager.SetAutoHideMode(this.treeView1, true);
	this.dockingManager.SetDockLabel(this.treeView1, &quot;TreeView&quot;);
	this.dockingManager.SetDockIcon(this.treeView1, 2);

	// Set checkedListBox1 to be initially in a floating position.
	Rectangle rcfrm = this.Bounds;
	this.dockingManager.FloatControl(this.checkedListBox1,
		new Rectangle(rcfrm.Right+25,rcfrm.Bottom-250,175,300));
	this.dockingManager.SetDockLabel(this.checkedListBox1, &quot;Checked ListBox&quot;);
	this.dockingManager.SetDockIcon(this.checkedListBox1, 3);
	this.dockingManager.EndInit();
}</code></pre></coderef>


Private Sub InitializeDockingWindows()
       &apos; Create the DockingManager instance and set this form as the host form.
       Me.dockingManager = New Syncfusion.Windows.Forms.Tools.DockingManager(Me.components)
       Me.dockingManager.BeginInit()
       Me.dockingManager.HostForm = Me

       &apos; Disable state persistence
       Me.dockingManager.PersistState = False
       &apos; Enable display of the default context menus
       Me.dockingManager.EnableContextMenu = True
       &apos; Set the imagelist that will provide the icons for the docking windows.
       Me.dockingManager.ImageList = Me.ilDocking

       &apos; Dock listbox1 to the left border of the form and with an initial
       &apos; width of 175 units.
       &apos; NOTE - Calling DockControl() on a control for the first time,
       &apos; will initialize it as a docking window. This is the equivalent of
       &apos; the DockingManager.SetEnableDocking() call.
       Me.dockingManager.DockControl(Me.listBox1, Me, Syncfusion.Windows.Forms.Tools.Syncfusion.Windows.Forms.Tools.DockingStyle.Left, 175)
       &apos; Set the text to be displayed in the dockingwindow caption
       Me.dockingManager.SetDockLabel(Me.listBox1, &quot;ListBox 1&quot;)
       &apos; The image index used for this control
       Me.dockingManager.SetDockIcon(Me.listBox1, 0)

       &apos; Now dock listbox2 as a tab onto listbox1
       Me.dockingManager.DockControl(Me.listBox2, Me.listBox1, Syncfusion.Windows.Forms.Tools.Syncfusion.Windows.Forms.Tools.DockingStyle.Tabbed, 175)
       Me.dockingManager.SetDockLabel(Me.listBox2, &quot;ListBox 2&quot;)
       Me.dockingManager.SetDockIcon(Me.listBox2, 1)

       &apos; Dock the treeView to the right border of the form with a width of 150.
       Me.dockingManager.DockControl(Me.treeView1, Me, Syncfusion.Windows.Forms.Tools.DockingStyle.Right, 150)
       &apos; Set treeView1 to start off in the AutoHide position.
       Me.dockingManager.SetAutoHideMode(Me.treeView1, True)
       Me.dockingManager.SetDockLabel(Me.treeView1, &quot;TreeView&quot;)
       Me.dockingManager.SetDockIcon(Me.treeView1, 2)

       &apos; Set checkedListBox1 to be initially in a floating position.
       Dim rcfrm As Rectangle
       rcfrm = Me.Bounds
       Me.dockingManager.FloatControl(Me.checkedListBox1, New Rectangle((rcfrm.Right + 25), (rcfrm.Bottom - 250), 175, 300))
       Me.dockingManager.SetDockLabel(Me.checkedListBox1, &quot;Checked ListBox&quot;)
       Me.dockingManager.SetDockIcon(Me.checkedListBox1, 3)
       Me.dockingManager.EndInit()

   End Sub</code></pre></coderef>

Constructors

DockingManager()

Overloaded. Creates a new instance of the DockingManager class.

Declaration

public DockingManager()

DockingManager(IContainer)

Creates a new instance of the DockingManager and initializes it with the container.

Declaration

public DockingManager(IContainer container)

Parameters

Type	Name	Description
System.ComponentModel.IContainer	container	An object implementing the System.ComponentModel.IContainer interface to associate with this instance of the DockingManager.

Fields

ahTabAnimate

Declaration

protected AHTabControl ahTabAnimate

Field Value

Type	Description
AHTabControl

alDockAreaControllers

Declaration

protected ArrayList alDockAreaControllers

Field Value

Type	Description
System.Collections.ArrayList

alEnableDocking

Declaration

protected ArrayList alEnableDocking

Field Value

Type	Description
System.Collections.ArrayList

alFFControllers

Declaration

protected ArrayList alFFControllers

Field Value

Type	Description
System.Collections.ArrayList

alInheritedControls

Declaration

protected ArrayList alInheritedControls

Field Value

Type	Description
System.Collections.ArrayList

alTargetManagers

Declaration

protected ArrayList alTargetManagers

Field Value

Type	Description
System.Collections.ArrayList

AnimationSpeed

Animation interval used by the auto hide timer

Declaration

public static int AnimationSpeed

Field Value

Type	Description
System.Int32

AnimationStep

Gets/Sets the step size of autohide animation.It can be used to control the speed of animation

Declaration

public static int AnimationStep

Field Value

Type	Description
System.Int32	An integer value specifying step size.Default is 25

Examples

This example describes how to prevent the animation when we hide controls

private void dockingManager1_AutoHideAnimationStart(object sender, Syncfusion.Windows.Forms.Tools.AutoHideAnimationEventArgs arg)
{
   if (arg.DockBorder == DockStyle.Left || arg.DockBorder == DockStyle.Right)
       Syncfusion.Windows.Forms.Tools.DockingManager.AnimationStep = arg.Bounds.Width;
   else
       Syncfusion.Windows.Forms.Tools.DockingManager.AnimationStep = arg.Bounds.Height;
}

Private Sub DockingManager1_AutoHideAnimationStart(ByVal sender As System.Object, ByVal arg As Syncfusion.Windows.Forms.Tools.AutoHideAnimationEventArgs) Handles DockingManager1.AutoHideAnimationStart
    If (arg.DockBorder = DockStyle.Left Or arg.DockBorder = DockStyle.Right) Then
        Syncfusion.Windows.Forms.Tools.DockingManager.AnimationStep = arg.Bounds.Width
    Else
        Syncfusion.Windows.Forms.Tools.DockingManager.AnimationStep = arg.Bounds.Height
    End If
End Sub

autoHideSelection

Declaration

protected AutoHideSelectionStyle autoHideSelection

Field Value

Type	Description
AutoHideSelectionStyle

autoHideTabInView

Declaration

protected AHTabControl autoHideTabInView

Field Value

Type	Description
AHTabControl

bAllowActivationEvents

Declaration

protected bool bAllowActivationEvents

Field Value

Type	Description
System.Boolean

bAllowTabsMoving

Declaration

protected bool bAllowTabsMoving

Field Value

Type	Description
System.Boolean

bApplyMinMaxExtents

Declaration

protected bool bApplyMinMaxExtents

Field Value

Type	Description
System.Boolean

BARITEM_IMAGES_PATH

Specifies the BARITEM_IMAGES_PATH.

Declaration

public static string BARITEM_IMAGES_PATH

Field Value

Type	Description
System.String

bAutoHideActiveControl

Declaration

protected bool bAutoHideActiveControl

Field Value

Type	Description
System.Boolean

bAutoHideEnabled

Declaration

protected bool bAutoHideEnabled

Field Value

Type	Description
System.Boolean

bCancelVisibilityChangingEvent

Declaration

protected bool bCancelVisibilityChangingEvent

Field Value

Type	Description
System.Boolean

bCloseEnabled

Declaration

protected bool bCloseEnabled

Field Value

Type	Description
System.Boolean

bControlScopeImages

Declaration

protected bool bControlScopeImages

Field Value

Type	Description
System.Boolean

bDesignProcess

Declaration

protected bool bDesignProcess

Field Value

Type	Description
System.Boolean

bDisallowFloating

Declaration

protected bool bDisallowFloating

Field Value

Type	Description
System.Boolean

bDockToFill

Declaration

protected bool bDockToFill

Field Value

Type	Description
System.Boolean

bEnableContextMenu

Declaration

protected bool bEnableContextMenu

Field Value

Type	Description
System.Boolean

bFiredVisibilityChangedEvent

Declaration

protected bool bFiredVisibilityChangedEvent

Field Value

Type	Description
System.Boolean

bFiredVisibilityChangingEvent

Declaration

protected bool bFiredVisibilityChangingEvent

Field Value

Type	Description
System.Boolean

bFloatingVisibility

Declaration

protected bool bFloatingVisibility

Field Value

Type	Description
System.Boolean

bFormClientBorder

Declaration

protected bool bFormClientBorder

Field Value

Type	Description
System.Boolean

bFreezeDockStateChangeEvents

Declaration

protected bool bFreezeDockStateChangeEvents

Field Value

Type	Description
System.Boolean

bFreezeResizing

Declaration

protected bool bFreezeResizing

Field Value

Type	Description
System.Boolean

bHoldEvents

Declaration

protected bool bHoldEvents

Field Value

Type	Description
System.Boolean

bHostActivatedVisibility

Declaration

protected bool bHostActivatedVisibility

Field Value

Type	Description
System.Boolean

bInBeginEndInit

Declaration

protected bool bInBeginEndInit

Field Value

Type	Description
System.Boolean

bLoadVisibility

Declaration

protected bool bLoadVisibility

Field Value

Type	Description
System.Boolean

bMaximizeEnabled

Declaration

protected bool bMaximizeEnabled

Field Value

Type	Description
System.Boolean

bMDIActivatedVisibility

Declaration

protected bool bMDIActivatedVisibility

Field Value

Type	Description
System.Boolean

bMdiFormClosing

Declaration

protected bool bMdiFormClosing

Field Value

Type	Description
System.Boolean

bMenuButtonEnabled

Declaration

protected bool bMenuButtonEnabled

Field Value

Type	Description
System.Boolean

bPersistState

Declaration

protected bool bPersistState

Field Value

Type	Description
System.Boolean

bThemesEnabled

Declaration

protected bool bThemesEnabled

Field Value

Type	Description
System.Boolean

bWaitOnLayoutEvent

Declaration

protected bool bWaitOnLayoutEvent

Field Value

Type	Description
System.Boolean

controllerInFocus

Declaration

protected DockHostController controllerInFocus

Field Value

Type	Description
DockHostController

ctrlLastActive

Declaration

protected Control ctrlLastActive

Field Value

Type	Description
System.Windows.Forms.Control

ctrlLastPainted

Declaration

protected Control ctrlLastPainted

Field Value

Type	Description
System.Windows.Forms.Control

dactivatedFlag

Declaration

protected int dactivatedFlag

Field Value

Type	Description
System.Int32

dcHostForm

Declaration

protected MainFormController dcHostForm

Field Value

Type	Description
MainFormController

dlAlignment

Declaration

protected DockLabelAlignmentStyle dlAlignment

Field Value

Type	Description
DockLabelAlignmentStyle

documentOnlyCollection

Holds the collection of the docking child with document mode only value.

Declaration

protected Hashtable documentOnlyCollection

Field Value

Type	Description
System.Collections.Hashtable

dsDockFillAHBorder

Declaration

protected DockingStyle dsDockFillAHBorder

Field Value

Type	Description
DockingStyle

dtAlignment

Declaration

protected DockTabAlignmentStyle dtAlignment

Field Value

Type	Description
DockTabAlignmentStyle

FramePainter

Frame painter

Declaration

public FramePainter FramePainter

Field Value

Type	Description
FramePainter

frmOwner

Declaration

protected Form frmOwner

Field Value

Type	Description
System.Windows.Forms.Form

ftAutoHideTab

Declaration

protected Font ftAutoHideTab

Field Value

Type	Description
System.Drawing.Font

ftDockTab

Declaration

protected Font ftDockTab

Field Value

Type	Description
System.Drawing.Font

ftSysInfoMenuFont

Declaration

protected static Font ftSysInfoMenuFont

Field Value

Type	Description
System.Drawing.Font

htAllowFloating

Declaration

protected Hashtable htAllowFloating

Field Value

Type	Description
System.Collections.Hashtable

htCustomCaptionButtons

Declaration

protected Hashtable htCustomCaptionButtons

Field Value

Type	Description
System.Collections.Hashtable

htDockAbility

Declaration

protected Hashtable htDockAbility

Field Value

Type	Description
System.Collections.Hashtable

htFloatOnly

Declaration

protected Hashtable htFloatOnly

Field Value

Type	Description
System.Collections.Hashtable

htHiddenOnLoad

Declaration

protected Hashtable htHiddenOnLoad

Field Value

Type	Description
System.Collections.Hashtable

htIcon

Declaration

protected Hashtable htIcon

Field Value

Type	Description
System.Collections.Hashtable

htmIcon

Declaration

protected Hashtable htmIcon

Field Value

Type	Description
System.Collections.Hashtable

htOuterDockAbility

Declaration

protected Hashtable htOuterDockAbility

Field Value

Type	Description
System.Collections.Hashtable

htText

Declaration

protected Hashtable htText

Field Value

Type	Description
System.Collections.Hashtable

ilDockTabs

Declaration

protected ImageList ilDockTabs

Field Value

Type	Description
System.Windows.Forms.ImageList

listAHOnLoad

Declaration

protected ArrayList listAHOnLoad

Field Value

Type	Description
System.Collections.ArrayList

m_bIsMirrored

Declaration

protected bool m_bIsMirrored

Field Value

Type	Description
System.Boolean

m_borderColor

Declaration

protected Color m_borderColor

Field Value

Type	Description
System.Drawing.Color

m_CaptionButtons

Declaration

protected CaptionButtonsCollection m_CaptionButtons

Field Value

Type	Description
CaptionButtonsCollection

m_freezeResizeCtrls

Declaration

protected ArrayList m_freezeResizeCtrls

Field Value

Type	Description
System.Collections.ArrayList

m_IsCaptionButtonsCleared

Declaration

protected bool m_IsCaptionButtonsCleared

Field Value

Type	Description
System.Boolean

m_mdiZOrder

Declaration

protected ArrayList m_mdiZOrder

Field Value

Type	Description
System.Collections.ArrayList

m_Office2007Theme

Declaration

protected Office2007Theme m_Office2007Theme

Field Value

Type	Description
Office2007Theme

m_Office2010Theme

Declaration

protected Office2010Theme m_Office2010Theme

Field Value

Type	Description
Office2010Theme

m_paintBorders

Declaration

protected bool m_paintBorders

Field Value

Type	Description
System.Boolean

m_Renderer

Declaration

protected DockingManagerRenderer m_Renderer

Field Value

Type	Description
DockingManagerRenderer

m_RendererStyle

Declaration

protected VisualStyle m_RendererStyle

Field Value

Type	Description
VisualStyle

MaxRedockFactor

Declaration

protected int MaxRedockFactor

Field Value

Type	Description
System.Int32

nAutoHideTabHeight

Declaration

protected int nAutoHideTabHeight

Field Value

Type	Description
System.Int32

nDockTabHeight

Declaration

protected int nDockTabHeight

Field Value

Type	Description
System.Int32

nHideInterval

Declaration

protected static int nHideInterval

Field Value

Type	Description
System.Int32

nShowInterval

Declaration

protected static int nShowInterval

Field Value

Type	Description
System.Int32

providerStyle

Declaration

protected DragProviderStyle providerStyle

Field Value

Type	Description
DragProviderStyle

stmLayout

Declaration

protected MemoryStream stmLayout

Field Value

Type	Description
System.IO.MemoryStream

strPersistKey

Declaration

protected const string strPersistKey = "DockStateInfo"

Field Value

Type	Description
System.String

windowModeCollection

Holds the collection of the docking child with document mode only value.

Declaration

protected Hashtable windowModeCollection

Field Value

Type	Description
System.Collections.Hashtable

Properties

ActiveCaptionBackground

Information about the brush using which the caption background is going to painted

Declaration

public BrushInfo ActiveCaptionBackground { get; set; }

Property Value

Type	Description
BrushInfo

ActiveCaptionButtonForeColor

Color of the caption button in active state.

Declaration

public Color ActiveCaptionButtonForeColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

ActiveCaptionFont

Gets or sets the Font of the active caption.

Declaration

public Font ActiveCaptionFont { get; set; }

Property Value

Type	Description
System.Drawing.Font

ActiveCaptionForeGround

Color of the caption text in active state.

Declaration

public Color ActiveCaptionForeGround { get; set; }

Property Value

Type	Description
System.Drawing.Color

ActiveControl

Returns the last active docking window.

Declaration

public Control ActiveControl { get; }

Property Value

Type	Description
System.Windows.Forms.Control	A System.Windows.Forms.Control value. Null if no window has been activated yet.

ActiveDockTabBackColor

Gets or sets the header background color of selected tab in dock window.

Declaration

public Color ActiveDockTabBackColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

ActiveDockTabForeColor

Gets or sets the header foreground color of active tab item in dock window.

Declaration

public Color ActiveDockTabForeColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

AHInViewTab

Declaration

protected AHTabControl AHInViewTab { get; set; }

Property Value

Type	Description
AHTabControl

AllowTabsMoving

Gets or sets value indicating whether allow to move tabs in tabcontrol of dock and document windows

Declaration

public bool AllowTabsMoving { get; set; }

Property Value

Type	Description
System.Boolean

AnimateAutoHiddenWindow

Declaration

public bool AnimateAutoHiddenWindow { get; set; }

Property Value

Type	Description
System.Boolean

AutoHideActiveControl

When docked control is in unpinned autohide state this value indicates whether to slide back selected control.

Declaration

public bool AutoHideActiveControl { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value. Default is FALSE.

AutoHideEnabled

Indicates whether the autohide feature is enabled.

Declaration

public bool AutoHideEnabled { get; set; }

Property Value

Type	Description
System.Boolean	FALSE indicates that the autohide feature is disabled. Default is TRUE.

Remarks

When this property is TRUE, all docked windows will contain an autohide button that can be used to set/unset the particular control to/from the autohide mode.

AutoHideInterval

Gets or sets the interval between mouse movement across an autohide tab and showing or hiding the control.

Declaration

public int AutoHideInterval { get; set; }

Property Value

Type	Description
System.Int32	An integer value specifying the time in milliseconds.

AutoHideSelectionStyle

Gets or sets the Selection style of Auto Hide window.

Declaration

public AutoHideSelectionStyle AutoHideSelectionStyle { get; set; }

Property Value

Type	Description
AutoHideSelectionStyle	The default value is AutoHideSelectionStyle.MouseHover.

AutoHideTabFont

Gets or sets the font for the autohide tab control.

Declaration

public Font AutoHideTabFont { get; set; }

Property Value

Type	Description
System.Drawing.Font	An integer value.

AutoHideTabForeColor

Gets/Sets the forecolor of the AutoHiden tab control.

Declaration

public Color AutoHideTabForeColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

AutoHideTabHeight

Gets or sets the height of the autohide tab control.

Declaration

public int AutoHideTabHeight { get; set; }

Property Value

Type	Description
System.Int32	An integer value.

BorderColor

Gets or sets the border color of docked controls.

Declaration

public Color BorderColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

BrowsingKey

Gets or sets the value of the key, which can be used to tab through the docked controls.

Declaration

public Keys BrowsingKey { get; set; }

Property Value

Type	Description
System.Windows.Forms.Keys

Examples

dockingManager1.BrowsingKey = Keys.F10;
dockingManager1.BrowsingKey=((System.Windows.Forms.Keys)(Enum.Parse(typeof(Keys), "F12, Shift, Control"))); //This will set Ctrl+Shift+F12 as browsing key

 DockingManager1.BrowsingKey = Keys.F10
 Me.DockingManager1.BrowsingKey = CType(Enum.Parse(typeof(Keys), "F12, Shift, Control"),System.Windows.Forms.Keys) 'This will set Ctrl+Shift+F12 as browsing key

CaptionButtons

Gets or sets the caption buttons collection.

Declaration

public CaptionButtonsCollection CaptionButtons { get; set; }

Property Value

Type	Description
CaptionButtonsCollection

CaptionHeight

Gets or sets the metric that defines the height of the caption area at the top of a docking child window.

Declaration

public int CaptionHeight { get; set; }

Property Value

Type	Description
System.Int32

Remarks

This property is not applicable for Default and VS2005 visual style. Maximum Caption height is 60.

CloseEnabled

Indicates whether the close button is present in docking windows.

Declaration

public bool CloseEnabled { get; set; }

Property Value

Type	Description
System.Boolean	FALSE indicates the close button is hidden. The default is TRUE.

Remarks

When this property is TRUE, all docking windows will contain a close button that can be used to hideItem the particular control.

CloseTabOnMiddleClick

Gets/Sets the boolean value to close tab pages/tabbed windows by Mouse Wheel Click.

Declaration

public bool CloseTabOnMiddleClick { get; set; }

Property Value

Type	Description
System.Boolean

Controls

Returns an enumerator that can iterate through the list of dockable controls.

Declaration

public IEnumerator Controls { get; }

Property Value

Type	Description
System.Collections.IEnumerator	A System.Collections.IEnumerator for the control list.

Examples

This example shows how to get the collection of controls

IEnumerator ienum = this.dockingManager1.Controls; 	
ArrayList dockedctrls = new ArrayList(); 	
while(ienum.MoveNext()) 	
    dockedctrls.Add(ienum.Current); 	
foreach(Control ctrl in dockedctrls) 	
    Console.WriteLine(ctrl.ToString());

	
Dim ienum As IEnumerator = Me.dockingManager1.Controls 	
Dim dockedctrls As ArrayList = New ArrayList() 	
Do While ienum.MoveNext() 	
    dockedctrls.Add(ienum.Current) 	
Loop	
Dim ctrl As Control	
For Each ctrl In dockedctrls	
Console.WriteLine(ctrl.ToString()) 	
Next

ControlsArray

Returns an array of dockable controls.

Declaration

public Control[] ControlsArray { get; }

Property Value

Type	Description
System.Windows.Forms.Control[]

ControlScopeImages

Indicates whether controls will provide their own images.

Declaration

public bool ControlScopeImages { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value; the default is FALSE.

Remarks

Setting the ControlScopeImages property to TRUE denotes that dockable controls will furnish the actual Image objects during initialization using the SetDockIcon(Control, Int32) overload that accepts an Icon parameter and these images will be bound to the control's lifetime as a docking window. This contrasts with the default implementation where the DockingManager references an object and controls merely provide the index to an Image in the ImageList.

DHCInFocus

Declaration

protected DockHostController DHCInFocus { get; set; }

Property Value

Type	Description
DockHostController

DisallowFloating

Indicates whether the controls are allowed to be floated.

Declaration

public bool DisallowFloating { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value. Default is FALSE.

Remarks

When the DisallowFloating property is set to TRUE, controls may be moved around and docked within the form or other dockable controls, but are not allowed to be floated.

DockAreaControllers

Gets the dock are controllers.

Declaration

public ArrayList DockAreaControllers { get; }

Property Value

Type	Description
System.Collections.ArrayList

DockBehavior

Gets/Sets Docking behavior of Docking Manager

Declaration

public DockBehavior DockBehavior { get; set; }

Property Value

Type	Description
DockBehavior

DockedCaptionFont

Gets/sets the caption font of the docked control

Declaration

public Font DockedCaptionFont { get; set; }

Property Value

Type	Description
System.Drawing.Font

DockLabelAlignment

Gets or sets the alignment of DockLabels.

Declaration

public DockLabelAlignmentStyle DockLabelAlignment { get; set; }

Property Value

Type	Description
DockLabelAlignmentStyle	The default value is DockLabelAlignmentStyle.Default.

DockLayoutStream

A MemoryStream containing the dockstate information set by the visual designer.

Declaration

public MemoryStream DockLayoutStream { get; set; }

Property Value

Type	Description
System.IO.MemoryStream

DockTabAlignment

Gets or sets the alignment of tabs in tab groups.

Declaration

public DockTabAlignmentStyle DockTabAlignment { get; set; }

Property Value

Type	Description
DockTabAlignmentStyle

DockTabBackColor

Gets or sets the tab header background color of inactive tabbed items in dock window.

Declaration

public Color DockTabBackColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

DockTabFont

Gets or sets the Font for the tab control used in tabbed docking groups.

Declaration

public Font DockTabFont { get; set; }

Property Value

Type	Description
System.Drawing.Font	A System.Drawing.Font value.

DockTabForeColor

Gets or sets the Forecolor of the Docked tab control.

Declaration

public Color DockTabForeColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

DockTabHeight

Gets or sets the height of the tab control used in tabbed docking groups.

Declaration

public int DockTabHeight { get; set; }

Property Value

Type	Description
System.Int32	An integer value.

DockTabPadX

Gets / sets the padding to use to the left of the tabs while calculating the tab positions. A float value representing the horizontal padding. The default value is 5.0F

Declaration

public float DockTabPadX { get; set; }

Property Value

Type	Description
System.Single

DockTabPanelBackColor

Gets or sets the tab panel background color of tabbed dock window.

Declaration

public Color DockTabPanelBackColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

DockTabSeparatorColor

Gets or sets the color to draw the separator between the tabs in dock window.

Declaration

public Color DockTabSeparatorColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

DockToFill

Indicates whether docked control will occupy the form's full client region.

Declaration

public bool DockToFill { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value; default is FALSE.

Remarks

When the DockToFill property is set to TRUE, controls are docked such that they occupy the host form's entire available client region.

The DockToFill option should not be set when the host form is an MDIContainer or if it contains an instance of the DockingClientPanel control.

DocumentWindowSettings

Declaration

public DocumentWindowSettings DocumentWindowSettings { get; }

Property Value

Type	Description
DocumentWindowSettings

DragFeedbackEventsOnSplitters

Enable or disable the firing of DragFeedback events upon dragging splitters.

Declaration

public bool DragFeedbackEventsOnSplitters { get; set; }

Property Value

Type	Description
System.Boolean

DragProviderStyle

Gets or sets the style of dragging.

Declaration

public DragProviderStyle DragProviderStyle { get; set; }

Property Value

Type	Description
DragProviderStyle

Remarks

The DragProviderStyle enumeration is used by the DockingManager to enable the style of dragging the docking windows. VS2005 style is set for Visual Studio 2005 by default. Standard style will be set for VS 2002 and VS 2003 .NET Framework.

EnableAutoAdjustCaption

Indicates whether to auto adjust selected caption in Autohide mode.

Declaration

public bool EnableAutoAdjustCaption { get; set; }

Property Value

Type	Description
System.Boolean	Boolean value. Default value is true.

Remarks

This property is not applicable for Visual style VS2005 and VS2010.

EnableAutoHideTabContextMenu

Indicates whether a AutoHideTab context menu is displayed.

Declaration

public bool EnableAutoHideTabContextMenu { get; set; }

Property Value

Type	Description
System.Boolean	FALSE indicates that the AutoHideTab context menu is not displayed. Default is TRUE.

Remarks

When this property is true, clicking the right mouse button over the AutoHideTab will display a context menu. The menu can be tailored by handling the AutoHideTabContextMenu event.

EnableContextMenu

Indicates whether a context menu is displayed.

Declaration

public bool EnableContextMenu { get; set; }

Property Value

Type	Description
System.Boolean	FALSE indicates that the context menu is not displayed. Default is TRUE.

Remarks

When this property is true, clicking the right mouse button over the caption area of a docking window will display a context menu. The menu can be tailored by handling the DockContextMenu event.

EnableDocumentMode

Gets or sets a value indicating whether DockingManager allows to create document windows or not.

Declaration

public bool EnableDocumentMode { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

DockingManager allows to create tabbed(TDI) windows for documents, if EnableDocumentMode is true.Otherwise DockingManager creates MDI window

EnableDoubleClickOnCaption

Enable or disable the state transition upon double click on caption

Declaration

public bool EnableDoubleClickOnCaption { get; set; }

Property Value

Type	Description
System.Boolean

EnableDragAutoHiddenTabs

Indicates whether the autohidden tabs can be dragged to make it float.

Declaration

public bool EnableDragAutoHiddenTabs { get; set; }

Property Value

Type	Description
System.Boolean	FALSE indicates that the dragging feature is disabled

Remarks

When this property is TRUE, all the autohidden tabs can be dragged to make them float.

EnableSuperToolTip

Gets or sets if to enable super tool tip for dock caption buttons.

Declaration

public bool EnableSuperToolTip { get; set; }

Property Value

Type	Description
System.Boolean

ForwardMenuShortcuts

Indicates whether the key combinations for menu shortcuts should be passed to the Host form

Declaration

public bool ForwardMenuShortcuts { get; set; }

Property Value

Type	Description
System.Boolean	True indicates all the key combinations will pass to the HOST form.

FreezeResizing

Indicates whether docked and floating windows can be resized using the medial splitters.

Declaration

public bool FreezeResizing { get; set; }

Property Value

Type	Description
System.Boolean	Resizing is disabled when TRUE. Default is FALSE.

FullCaptionsInAutoHideMode

Indicates whether to show full autohide tabgroup's page caption.

Declaration

public bool FullCaptionsInAutoHideMode { get; set; }

Property Value

Type	Description
System.Boolean	Boolean value. Default value is FALSE.

HoldEvents

Declaration

protected bool HoldEvents { get; }

Property Value

Type	Description
System.Boolean

HostActivatedVisibility

Indicates whether to bind floating control visibility state to the host control's visibility.

Declaration

public bool HostActivatedVisibility { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value. Default is TRUE.

Remarks

When the HostActivatedVisibility property is enabled floating controls associated with a DockingManager hosted in a ContainerControl will be shown only when the host control is visible. Hiding the host control will automatically hide all floating windows tied to that control.

NOTE: This property applies only when the DockingManager is hosted in a ContainerControl.

MDIActivatedVisibility

HostControl

Gets or sets the Control hosting the DockingManager and all the associated dockable controls.

Declaration

public ContainerControl HostControl { get; set; }

Property Value

Type	Description
System.Windows.Forms.ContainerControl	The System.Windows.Forms.Control that will host the docking windows.

Remarks

This property references the Control containing the DockingManager and all the dockable controls. A Control can contain only a single instance of the DockingManager.

HostForm

Gets or sets the form hosting the DockingManager and all the associated dockable controls.

Declaration

public Form HostForm { get; set; }

Property Value

Type	Description
System.Windows.Forms.Form	The System.Windows.Forms.Form that will host the docking windows.

Remarks

This property references the form containing the DockingManager and all the dockable controls. A form can contain only a single instance of the DockingManager.

HostFormClientBorder

Indicates whether a border is drawn around the host form's client rectangle.

Declaration

public bool HostFormClientBorder { get; set; }

Property Value

Type	Description
System.Boolean	FALSE indicates that the border is hidden. The default is TRUE.

Remarks

When this property is TRUE, the HostForm's available client rectangle is enveloped by a single-line border. The border will not be drawn if the form is an MDIContainer or if it contains a DockingClientPanel control.

HostFormMdiManager

Declaration

protected TabbedMDIManager HostFormMdiManager { get; }

Property Value

Type	Description
TabbedMDIManager

ImageList

Gets or sets the imagelist containing the image objects used by the dockable controls.

Declaration

public ImageList ImageList { get; set; }

Property Value

Type	Description
System.Windows.Forms.ImageList	A System.Windows.Forms.ImageList containing the images associated with the various docking windows.

ImportDockingControl

Gets or sets a value indicating whether docking control should be imported.

Declaration

public bool ImportDockingControl { get; set; }

Property Value

Type	Description
System.Boolean	`true` if docking control should be imported; otherwise, `false`.

InActiveCaptionBackground

Information about the brush using which the caption background is going to painted when the docked control is in inactive state.

Declaration

public BrushInfo InActiveCaptionBackground { get; set; }

Property Value

Type	Description
BrushInfo

InActiveCaptionButtonForeColor

Color of the caption button in inactive state.

Declaration

public Color InActiveCaptionButtonForeColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

InActiveCaptionFont

Gets or sets the font of the inactive caption.

Declaration

public Font InActiveCaptionFont { get; set; }

Property Value

Type	Description
System.Drawing.Font

InActiveCaptionForeGround

Color of the caption text in inactive state.

Declaration

public Color InActiveCaptionForeGround { get; set; }

Property Value

Type	Description
System.Drawing.Color

IsLayoutSuspended

Specifies if the DockingManager is currently suspended.

Declaration

public bool IsLayoutSuspended { get; }

Property Value

Type	Description
System.Boolean

LastActiveControl

Get or sets the previous active control.

Declaration

protected Control LastActiveControl { get; set; }

Property Value

Type	Description
System.Windows.Forms.Control

Remarks

Internal Property used to persist the Last (previous) active control of the docking manager when the container of the docking manager lose the focus. This is mainly used to persist the control when the Main Form Lose it's focus when a pop up like messagebox is shown.

MaximizeButtonEnabled

Indicates whether the maximize button is present in docking windows.

Declaration

public bool MaximizeButtonEnabled { get; set; }

Property Value

Type	Description
System.Boolean	FALSE indicates the maximize button is hidden. The default is TRUE.

Remarks

When this property is TRUE, all docking windows will contain a maximize button that can be used to maximize the particular control.

MDIActivatedVisibility

Enables or disables the MDI child activation triggered floating control visibility.

Declaration

public bool MDIActivatedVisibility { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value. Default is TRUE.

Remarks

When the MDIActivatedVisibility property is enabled floating controls associated with DockingManagers hosted in MDI child forms will be shown only when the particular form is the active MDI child. When the MDI child loses activation all floating windows tied to the DockingManager will be hidden.

NOTE: This property applies only when the DockingManager is hosted, either directly or indirectly through a ContainerControl, in an MDI child form.

HostActivatedVisibility

MenuButtonEnabled

Indicates whether the menu button is enabled.

Declaration

public bool MenuButtonEnabled { get; set; }

Property Value

Type	Description
System.Boolean	FALSE indicates that the menu button is disabled. Default is TRUE.

Remarks

When this property is TRUE, all docked windows will contain the menu button that can be used to show context menu with dock/float/autohide functionalities

MenuStyle

Gets or sets the menu style.

Declaration

public DockMenuStyle MenuStyle { get; set; }

Property Value

Type	Description
DockMenuStyle

MetroBorderWidth

Gets/Sets the border width for FloatingForm in MetroTheme.

Declaration

public int MetroBorderWidth { get; set; }

Property Value

Type	Description
System.Int32

MetroButtonColor

Gets or sets the Caption button color when Visual style is set as Metro.

Declaration

public Color MetroButtonColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

MetroCaptionColor

Gets or sets the fore color of the Active caption when Visual style is set as Metro.

Declaration

public Color MetroCaptionColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

MetroColor

Indicates the metro color.

Declaration

public Color MetroColor { get; set; }

Property Value

Type	Description
System.Drawing.Color	Default value is true.

MetroInactiveCaptionColor

Gets or sets the forecolor of the Inactive caption. This property is only applicable when Visual Style is set as Metro.

Declaration

public Color MetroInactiveCaptionColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

MetroSplitterBackColor

Gets or sets the splitter back color when Visual style is set as Metro.

Declaration

public Color MetroSplitterBackColor { get; set; }

Property Value

Type	Description
System.Drawing.Color

NeedDTFPriorityController

Gets or sets whether PriorityController need to be set when in DockToFill mode.

Declaration

public bool NeedDTFPriorityController { get; set; }

Property Value

Type	Description
System.Boolean

NeedFloatFormRepaint

Gets or sets a value indicating whether floating form need to be repainted.

Declaration

public bool NeedFloatFormRepaint { get; set; }

Property Value

Type	Description
System.Boolean	`true` if floating form repaint needed; otherwise, `false`.

Remarks

If there is any flickering while resizing floating form, this property can be set to false. This property is applicable for visual styles other than Default and VS2005.

Office2007MdiChildForm

Gets or sets if docking MDI children should be in Office2007 style.

Declaration

public bool Office2007MdiChildForm { get; set; }

Property Value

Type	Description
System.Boolean	`true` if Office2007MdiChildForm; otherwise, `false`. The default value is false.

Office2007MdiColorScheme

Gets or sets color scheme for Office2007 MDI children The default value is Office2007Theme.Managed

Declaration

public Office2007Theme Office2007MdiColorScheme { get; set; }

Property Value

Type	Description
Office2007Theme

Office2007Theme

Gets or sets color theme for Office2007-like visual styles.

Declaration

public Office2007Theme Office2007Theme { get; set; }

Property Value

Type	Description
Office2007Theme

Office2010Theme

Gets or sets color theme for Office2010-like visual styles.

Declaration

public Office2010Theme Office2010Theme { get; set; }

Property Value

Type	Description
Office2010Theme

PaintBorders

Indicates whether to paint docked control's borders.

Declaration

public bool PaintBorders { get; set; }

Property Value

Type	Description
System.Boolean

PersistenceID

Declaration

protected virtual string PersistenceID { get; }

Property Value

Type	Description
System.String

PersistKey

Returns the key used for serializing the DockingManager state information.

Declaration

protected virtual string PersistKey { get; }

Property Value

Type	Description
System.String	A String value.

Remarks

This method can be overridden to provide a custom serialization key.

PersistState

Indicates whether the application's docking windows state should be persisted.

Declaration

public bool PersistState { get; set; }

Property Value

Type	Description
System.Boolean	TRUE indicates the application's dock state will be persisted. Default is FALSE.

Remarks

When this property is set to TRUE, the application's dock state will be persisted upon application exit and restored during the subsequent launch.

ReduceFlickeringInRtl

Gets or sets a value indicating whether to reduce flickering in RTL mode on startup.

Declaration

public bool ReduceFlickeringInRtl { get; set; }

Property Value

Type	Description
System.Boolean	`true` if reduce flickering in RTL mode; otherwise, `false`.

RightToLeft

Returns the current RTL setting based on the host control's setting.

Declaration

public RightToLeft RightToLeft { get; }

Property Value

Type	Description
System.Windows.Forms.RightToLeft

ShowCaption

Indicates whether to paint panel's caption.

Declaration

public bool ShowCaption { get; set; }

Property Value

Type	Description
System.Boolean	Boolean value. Default value is True.

ShowCaptionImages

Determines whether to show images in captions of docked controls and floating forms.

Declaration

public bool ShowCaptionImages { get; set; }

Property Value

Type	Description
System.Boolean

ShowCustomButtonsInFloating

Gets or Sets a value indicating whether custom buttons can be drawn in floating window

Declaration

public bool ShowCustomButtonsInFloating { get; set; }

Property Value

Type	Description
System.Boolean

ShowDockTabScrollButton

Gets or sets if to display scroll button on DockTabControl.

Declaration

public bool ShowDockTabScrollButton { get; set; }

Property Value

Type	Description
System.Boolean

ShowIconInAutoHideContextMenu

Determines whether to show icons in AutoHide context menu.

Declaration

public bool ShowIconInAutoHideContextMenu { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true.

ShowMetroCaptionDottedLines

Gets or sets the visibility of the ShowMetroCaptionDottedLines.

Declaration

public bool ShowMetroCaptionDottedLines { get; set; }

Property Value

Type	Description
System.Boolean	true, if lines are shown. otherwise false. The default value is true.

ShowToolTips

Indicates the visibility state for docking panel button's tooltip.

Declaration

public bool ShowToolTips { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true.

SplitterWidth

Gets or sets the width of splitters between docking windows.

Declaration

public int SplitterWidth { get; set; }

Property Value

Type	Description
System.Int32	Integer value between 0 and 30. Default value is 4.

SuperToolTip

Gets or sets the tooltip used by the dockable controls.

Declaration

public SuperToolTip SuperToolTip { get; set; }

Property Value

Type	Description
SuperToolTip	A SuperToolTip instance.

TargetManagers

Declaration

protected ArrayList TargetManagers { get; }

Property Value

Type	Description
System.Collections.ArrayList

ThemesEnabled

Indicates whether XP Themes(visual styles) should be used for the docking windows.

Declaration

public bool ThemesEnabled { get; set; }

Property Value

Type	Description
System.Boolean	True to turn on themes; false otherwise.

ThemeStyle

Gets or sets the DockingManagerVisualStyle value used to customize the appearance of the DockingManager.

Declaration

public DockingManagerVisualStyle ThemeStyle { get; set; }

Property Value

Type	Description
DockingManagerVisualStyle

Remarks

This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

ToolTipInterval

Gets or sets the tooltipintervel for DockingManger using tooltip.

Declaration

public int ToolTipInterval { get; set; }

Property Value

Type	Description
System.Int32	A SuperToolTip instance.

UseBalloonStyleToolTip

Gets or sets the Ballon style for DockingManger using tooltip.

Declaration

public bool UseBalloonStyleToolTip { get; set; }

Property Value

Type	Description
System.Boolean	A SuperToolTip instance.

ValidatingCancelledControl

Get or sets the Validating cancelled control if any.

Declaration

protected Control ValidatingCancelledControl { get; set; }

Property Value

Type	Description
System.Windows.Forms.Control

Remarks

Internal Property used to restore the focus when validating is cancelled by any of the child controls.

VisualStyle

Gets or sets the visual style for the docking controls. OfficeXP style will reflect the Office2003 style.

Declaration

public VisualStyle VisualStyle { get; set; }

Property Value

Type	Description
VisualStyle	A VisualStyle containing the various visual styles.

Methods

ActivateControl(Control)

Activates the specified dockable control.

Declaration

public void ActivateControl(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control instance.

Remarks

If the control is in the AutoHide mode or is part of a tabbed docking group, then invoking this method will bring the control to the foreground and set focus to it.

AddControllerToDockingManager(DockHostController)

Adds controller to the docking manager.

Declaration

public void AddControllerToDockingManager(DockHostController dhc)

Parameters

Type	Name	Description
DockHostController	dhc	Dock host controller.

AddToTargetManagersList(DockingManager)

Adds the DockingManager to the target providers list belonging to the current manager.

Declaration

public void AddToTargetManagersList(DockingManager dockingmgr)

Parameters

Type	Name	Description
DockingManager	dockingmgr	The DockingManager to be added to the target list.

Remarks

Specifying a DockingManager as a target provider by adding it to another DockingManager's target list allows controls from the source manager to be dragged and docked onto the docking layout hosted by the target manager. RemoveFromTargetManagersList(DockingManager) TransferringFromManager TransferredToManager

ApplyDeserializedState(DockHostController, DHCSerializationWrapper)

Declaration

protected void ApplyDeserializedState(DockHostController dhc, DHCSerializationWrapper dhcwrapper)

Parameters

Type	Name	Description
DockHostController	dhc
DHCSerializationWrapper	dhcwrapper

ApplyDeserializedState(DockHostController, DockingMgrSerializationWrapperAdv)

Declaration

protected void ApplyDeserializedState(DockHostController dhc, DockingMgrSerializationWrapperAdv dmgrwrapper)

Parameters

Type	Name	Description
DockHostController	dhc
DockingMgrSerializationWrapperAdv	dmgrwrapper

ApplyDeserializedState(DockingMgrSerializationWrapper)

Applies deserialized state to the control.

Declaration

public virtual void ApplyDeserializedState(DockingMgrSerializationWrapper dmgrserializer)

Parameters

Type	Name	Description
DockingMgrSerializationWrapper	dmgrserializer	Docking manager serialization wrapper

ApplyDeserializedState(DockingMgrSerializationWrapperAdv)

Applies deserialized state.

Declaration

public virtual void ApplyDeserializedState(DockingMgrSerializationWrapperAdv dmgrserializer)

Parameters

Type	Name	Description
DockingMgrSerializationWrapperAdv	dmgrserializer	The DockingMgrSerializationWrapperAdv instance.

ApplyDHCFloatOnlySettings()

Declaration

protected void ApplyDHCFloatOnlySettings()

AssembleTabControl(ArrayList)

Declaration

protected DockTabController AssembleTabControl(ArrayList hostControllers)

Parameters

Type	Name	Description
System.Collections.ArrayList	hostControllers

Returns

Type	Description
DockTabController

AttemptFloatingFormDCRDocking(DockHostController, IEnumerator)

Declaration

protected bool AttemptFloatingFormDCRDocking(DockHostController ctrl, IEnumerator iedcr)

Parameters

Type	Name	Description
DockHostController	ctrl
System.Collections.IEnumerator	iedcr

Returns

Type	Description
System.Boolean

BeginInit()

Begins the initialization of the DockingManager component.

Declaration

public virtual void BeginInit()

CallWndProc(Int32, IntPtr, IntPtr)

ICallWndProcListener implementation.

Declaration

public void CallWndProc(int nCode, IntPtr wparam, IntPtr lparam)

Parameters

Type	Name	Description
System.Int32	nCode
System.IntPtr	wparam	The system message to progress.
System.IntPtr	lparam	The system message to progress.

CanExtend(Object)

Implementation of the IExtenderProvider::CanExtend method.

Declaration

public bool CanExtend(object target)

Parameters

Type	Name	Description
System.Object	target	The target of the control.

Returns

Type	Description
System.Boolean

CollectControllers(ArrayList)

Declaration

protected ArrayList CollectControllers(ArrayList controls)

Parameters

Type	Name	Description
System.Collections.ArrayList	controls

Returns

Type	Description
System.Collections.ArrayList

ContainsSerializationInfo(AppStateSerializer, Control)

Specifies whether control contains serialization information.

Declaration

public bool ContainsSerializationInfo(AppStateSerializer serializer, Control ctrl)

Parameters

Type	Name	Description
AppStateSerializer	serializer	The AppStateSerializer
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Boolean

CreateDockHost(Control)

Declaration

protected virtual DockHost CreateDockHost(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl

Returns

Type	Description
DockHost

CreateFloatingForm()

Creates an instance of FloatingForm.

Declaration

protected virtual FloatingForm CreateFloatingForm()

Returns

Type	Description
FloatingForm	A FloatingForm that has been created.

CreateMainFormController(ContainerControl)

Declaration

protected virtual MainFormController CreateMainFormController(ContainerControl hostcontrol)

Parameters

Type	Name	Description
System.Windows.Forms.ContainerControl	hostcontrol

Returns

Type	Description
MainFormController

Dispose(Boolean)

Overridden. See System.ComponentModel.Component.Dispose.

Declaration

protected override void Dispose(bool bdisposing)

Parameters

Type	Name	Description
System.Boolean	bdisposing

DockAsDocument(Control)

Initializes the control as a docking window in DockingManager and move the window into the document state.

Declaration

public void DockAsDocument(Control dockingChild)

Parameters

Type	Name	Description
System.Windows.Forms.Control	dockingChild	The control to be dock as document.

Remarks

Document state is enabled only when UseDocumentContainer property is enabled in DockingManager.

Examples

//Add the document container to the hostform of the DockingManager
dockingManager1.UseDocumentContainer= true;
//Dock the panel1 in document state.
dockingManager1.DockAsDocument(panel1));

'Add the document container to the hostform of the DockingManager
DockingManager1.UseDocumentContainer= true
'Dock the panel1 in document state.
DockingManager1.dockingManager1.DockAsDocument(panel1))

DockControl(Control, Control, DockingStyle, Int32)

Declaration

public virtual void DockControl(Control ctrl, Control parent, DockingStyle dockstyle, int nsize)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl
System.Windows.Forms.Control	parent
DockingStyle	dockstyle
System.Int32	nsize

DockControl(Control, Control, DockingStyle, Int32, Boolean)

Docks the control to the specified dock-enabled parent control.

Declaration

public virtual void DockControl(Control ctrl, Control parent, DockingStyle dockstyle, int nsize, bool tabGroup)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control to be docked.
System.Windows.Forms.Control	parent	The parent control that will host the new control. This can be the HostForm or any other dock-enabled control.
DockingStyle	dockstyle	A DockingStyle value that specifies the dock type\position.
System.Int32	nsize	Specifies the docked bounds for the control.
System.Boolean	tabGroup	Indicates whether to dock whole tab group or specified control only. If control is not part of tab group this parameter is ignored.

Remarks

The DockingStyle value provides the docking information and size. The interpretation of the dockstyle and nsize values depends upon the context of the dock operation.

Examples

//Code to dock a control to left of HostForm with width 100
dockingManager1.DockControl(panel1,this,Syncfusion.Windows.Forms.Tools.DockingStyle.Left,100);
//Code to dock a control(panel1) to top of another docked control(panel2).
dockingManager1.DockControl(panel1,panel2,Syncfusion.Windows.Forms.Tools.DockingStyle.Top,100);//panel1 will take space from panel2 at the top
//Code to dock a control(panel1) into another docked control(panel2) in tabbed style
dockingManager1.DockControl(panel1,panel2,Syncfusion.Windows.Forms.Tools.DockingStyle.Tabbed,100);
//Code to Dock a control(panel1) into another docked control(panel2) in tabbed style with whole tab group
dockingManager1.DockControl(panel1,panel2,DockingStyle.Tabbed,150,false);

'Code to dock a control to left side of HostForm with width 100
DockingManager1.DockControl(Panel1,this,Syncfusion.Windows.Forms.Tools.DockingStyle.Left,100);
'Code to dock a control(Panel1) to top of another docked control(Panel2).
DockingManager1.DockControl(panel1,panel2,Syncfusion.Windows.Forms.Tools.DockingStyle.Top,100);//Panel1 will take space from Panel2 at the top
'Code to dock a control(Panel1) into another docked control(Panel2) in tabbed style
DockingManager1.DockControl(Panel1,Panel2,Syncfusion.Windows.Forms.Tools.DockingStyle.Tabbed,100);
'Code to Dock a control(Panel1) into another docked control(Panel2) in tabbed style with whole tab group
DockingManager1.DockControl(Panel1,Panel2,DockingStyle.Tabbed,150,false);

DockControlInAutoHideMode(Control, DockingStyle, Int32)

Initializes the control as a docking window and sets it to be in the autohide mode.

Declaration

public void DockControlInAutoHideMode(Control ctrl, DockingStyle edge, int size)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control instance.
DockingStyle	edge	The host container edge along which the control will be autohidden.
System.Int32	size	The autohide window size.

DockToFormController(DockStateControllerBase)

Declaration

protected void DockToFormController(DockStateControllerBase ctrl)

Parameters

Type	Name	Description
DockStateControllerBase	ctrl

DockToNewSizingController(DockStateControllerBase)

Declaration

protected void DockToNewSizingController(DockStateControllerBase ctrl)

Parameters

Type	Name	Description
DockStateControllerBase	ctrl

DockToNewSizingControllerFillMode(DockStateControllerBase)

Declaration

protected void DockToNewSizingControllerFillMode(DockStateControllerBase ctrl)

Parameters

Type	Name	Description
DockStateControllerBase	ctrl

DockToSizingController(DockStateControllerBase)

Declaration

protected void DockToSizingController(DockStateControllerBase ctrl)

Parameters

Type	Name	Description
DockStateControllerBase	ctrl

EndInit()

Ends the initialization of the DockingManager component.

Declaration

public virtual void EndInit()

FireAutoHideAnimationEvent(String, AutoHideAnimationEventArgs)

Declaration

protected void FireAutoHideAnimationEvent(string strevent, AutoHideAnimationEventArgs arg)

Parameters

Type	Name	Description
System.String	strevent
AutoHideAnimationEventArgs	arg

FireAutoHideTabContextMenuEvent(AutoHideTabContextMenuEventArgs)

Declaration

protected void FireAutoHideTabContextMenuEvent(AutoHideTabContextMenuEventArgs ahcmenuargs)

Parameters

Type	Name	Description
AutoHideTabContextMenuEventArgs	ahcmenuargs

FireControlSizeStateChanged(ControlSizeStates, ControlSizeStateChangedEventArgs)

Declaration

protected void FireControlSizeStateChanged(ControlSizeStates newState, ControlSizeStateChangedEventArgs args)

Parameters

Type	Name	Description
ControlSizeStates	newState
ControlSizeStateChangedEventArgs	args

FireDockAllowEvent(DockAllowEventArgs)

Declaration

protected void FireDockAllowEvent(DockAllowEventArgs arg)

Parameters

Type	Name	Description
DockAllowEventArgs	arg

FireDockControlActivatingEvent(DockControlActivatingEventArgs)

Raises the DockControlActivating event.

Declaration

protected void FireDockControlActivatingEvent(DockControlActivatingEventArgs args)

Parameters

Type	Name	Description
DockControlActivatingEventArgs	args	A DockControlActivatingEventArgs that contains the event data.

FireDockMenuClickEvent(Control, DockingStyle)

Declaration

protected void FireDockMenuClickEvent(Control dockControl, DockingStyle ds)

Parameters

Type	Name	Description
System.Windows.Forms.Control	dockControl
DockingStyle	ds

FireDockStateChangeEvent(String, DockStateChangeEventArgs)

Declaration

protected void FireDockStateChangeEvent(string strevent, DockStateChangeEventArgs arg)

Parameters

Type	Name	Description
System.String	strevent
DockStateChangeEventArgs	arg

FireDockVisibilityChangedEvent(DockVisibilityChangedEventArgs)

Declaration

protected void FireDockVisibilityChangedEvent(DockVisibilityChangedEventArgs arg)

Parameters

Type	Name	Description
DockVisibilityChangedEventArgs	arg

FireDockVisibilityChangingEvent(DockVisibilityChangingEventArgs)

Declaration

protected void FireDockVisibilityChangingEvent(DockVisibilityChangingEventArgs arg)

Parameters

Type	Name	Description
DockVisibilityChangingEventArgs	arg

FireDragAllowEvent(DragAllowEventArgs)

Declaration

protected void FireDragAllowEvent(DragAllowEventArgs arg)

Parameters

Type	Name	Description
DragAllowEventArgs	arg

FireDragFeedbackEvent(String)

Declaration

protected void FireDragFeedbackEvent(string strevent)

Parameters

Type	Name	Description
System.String	strevent

FirePreviewDockHintsEvent(PreviewDockHintsEventArgs)

Raises the PreviewDockHints event.

Declaration

protected void FirePreviewDockHintsEvent(PreviewDockHintsEventArgs args)

Parameters

Type	Name	Description
PreviewDockHintsEventArgs	args	PreviewDockHintsEventArgs that contains the event data.

FireProvideGraphicsItemsEvent(ProvideGraphicsItemsEventArgs)

Declaration

protected void FireProvideGraphicsItemsEvent(ProvideGraphicsItemsEventArgs arg)

Parameters

Type	Name	Description
ProvideGraphicsItemsEventArgs	arg

FloatControl(Control, Rectangle)

Sets the control as a separate floating window.

Declaration

public virtual void FloatControl(Control ctrl, Rectangle rcscreen)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control to be floated.
System.Drawing.Rectangle	rcscreen	The bounds for the floating parent frame.

Remarks

Floats the control as a resizable frame using the coordinates and bounds specified by the rcscreen parameter.

Examples

//Float control panel1 in specified manner.
dockingManager1.FloatControl(panel1,new Rectangle(1,1,200,200));

'Float control panel1 in specified manner.
DockingManager1.FloatControl(Panel1,new Rectangle(1,1,200,200))

FloatControl(Control, Rectangle, Boolean)

Sets the control as a separate floating window.

Declaration

public virtual void FloatControl(Control ctrl, Rectangle rcscreen, bool bTabFloating)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control to be floated.
System.Drawing.Rectangle	rcscreen	The bounds for the floating parent frame.
System.Boolean	bTabFloating	When control is on DockTabPage, make entire DockTabControl floating if true.

Remarks

Floats the control as a resizable frame using the coordinates and bounds specified by the rcscreen parameter.

Examples

//Float control panel1 in specified manner.
dockingManager1.FloatControl(panel1,new Rectangle(1,1,200,200),true);

'Float control panel1 in specified manner.
DockingManager1.FloatControl(Panel1,new Rectangle(1,1,200,200),true)

FreezeToDocumentState(Control, Boolean)

Set the dockability of docking child as document alone.

Declaration

public void FreezeToDocumentState(Control dockingChild, bool freezeDocument)

Parameters

Type	Name	Description
System.Windows.Forms.Control	dockingChild	The control to be dock as document mode only.
System.Boolean	freezeDocument	Indicates whether the docked control is specified as document mode only or not.

Remarks

Once we set docking child as FreezeToDocumentState, we cannot move the document window to float or other states.

Examples

//Add the document container to the hostform of the DockingManager
dockingManager1.EnableDocumentMode= true;
//Dock the panel1 in document state.

dockingManager1.FreezeToDocumentState(panel1, true);

'Add the document container to the hostform of the DockingManager
DockingManager1.EnableDocumentMode= true
'Dock the panel1 in document state.
DockingManager1.dockingManager1.FreezeToDocumentState(panel1, true))

GetAllowFloating(Control)

Indicates whether the control can transit to floating state.

Declaration

public bool GetAllowFloating(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Boolean	TRUE if the control can transit to floating state.

GetAutoHideButtonToolTip()

Returns the auto hide button's tooltip.

Declaration

public string GetAutoHideButtonToolTip()

Returns

Type	Description
System.String	A System.String value which is displaying as the tooltip of AutoHideButton.

GetAutoHideButtonVisibility(Control)

Returns the visibility state for the docking window's autohide button.

Declaration

public bool GetAutoHideButtonVisibility(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Boolean	TRUE if the autohide button is displayed. Default is TRUE.

GetAutoHideMode(Control)

Indicates the autohide mode of the control.

Declaration

public bool GetAutoHideMode(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dockable control for which the autohide mode is being queried.

Returns

Type	Description
System.Boolean	TRUE if the control is in autohide.

GetAutoHideOnLoad(Control)

Specifies whether the docking window should be in the autohide mode on application startup.

Declaration

public bool GetAutoHideOnLoad(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Boolean

GetCaptionButtonDefaultName()

Declaration

protected string GetCaptionButtonDefaultName()

Returns

Type	Description
System.String

GetCloseButtonToolTip()

Returns the close button's tooltip.

Declaration

public string GetCloseButtonToolTip()

Returns

Type	Description
System.String	A System.Stringvalue which is displaying as the tooltip of Close Button.

GetCloseButtonVisibility(Control)

Returns the visibility state for the docking window's close button.

Declaration

public bool GetCloseButtonVisibility(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Boolean	TRUE if the close button is displayed. Default is TRUE.

GetControlMinimumSize(Control)

Returns the minimum bounds specified for the dockable control.

Declaration

public Size GetControlMinimumSize(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The docking window.

Returns

Type	Description
System.Drawing.Size	A System.Drawing.Size value indicating the minimum bounds. The default value is Size.Empty.

GetControlName(String)

Helps to override the ThemeName property settings

Declaration

public override string GetControlName(string controlName)

Parameters

Type	Name	Description
System.String	controlName	ThemeName

Returns

Type	Description
System.String

Overrides

BaseComponent.GetControlName(String)

GetControlSize(Control)

Gets the size of the dockable control.

Declaration

public Size GetControlSize(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The docked or floating control.

Returns

Type	Description
System.Drawing.Size	Size of the dockable control.

GetCustomCaptionButtons(Control)

Gets custom caption buttons collection for each docked control.

Declaration

public CaptionButtonsCollection GetCustomCaptionButtons(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
CaptionButtonsCollection

GetDefaultCaptionButtons()

Declaration

protected CaptionButtonsCollection GetDefaultCaptionButtons()

Returns

Type	Description
CaptionButtonsCollection

GetDockAbility(Control)

Indicates whether user can dock in this control, using drag providers (Arrow drag providers only).

Declaration

public DockAbility GetDockAbility(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
DockAbility

GetDockControllerFromManager(DockingManager, Control, Point)

Declaration

protected DockControllerBase GetDockControllerFromManager(DockingManager dockingmgr, Control ptctrl, Point pt)

Parameters

Type	Name	Description
DockingManager	dockingmgr
System.Windows.Forms.Control	ptctrl
System.Drawing.Point	pt

Returns

Type	Description
DockControllerBase

GetDockHostController(Control)

Declaration

protected DockHostController GetDockHostController(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl

Returns

Type	Description
DockHostController

GetDockIcon(Control)

Returns the index of the image associated with the docking window.

Declaration

public int GetDockIcon(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Int32	A zero-based index into the ImageList property value.

GetDockLabel(Control)

Returns the text displayed in the docking window caption.

Declaration

public string GetDockLabel(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.String	A String value representing the text caption.

GetDockStyle(Control)

Returns the current docking style of the control.

Declaration

public DockingStyle GetDockStyle(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The Instance of a control.

Returns

Type	Description
DockingStyle	A DockingStyle value that specifies the dock type\position.

Remarks

Control must be enabled for docking. It will return DockingStyle.Fill for Floating state and Tabbed group.

GetDockVisibility(Control)

Returns the docking window's visibility state.

Declaration

public bool GetDockVisibility(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control for which the DockVisibility is to be queried.

Returns

Type	Description
System.Boolean	TRUE if the control is a part of the current dock set; FALSE if it has been closed.

Remarks

A control's DockVisibility indicates whether the control is currently 'closed' or is an active participant in the interactions within the current set of docking windows. This is different from the Control.Visible property as a dockable control that is not visible may still be a part of the docking implementation such as when it is in the autohide or tabbed docking modes.

GetEnableDocking(Control)

Indicates whether the control is a docking window.

Declaration

public bool GetEnableDocking(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control to be queried.

Returns

Type	Description
System.Boolean	TRUE if the control is a docking window; FALSE otherwise.

GetFloatingDockHostController(Control)

Generate DockHostController of Floating Form in VS 2010 DockBehavior

Declaration

protected DockHostController GetFloatingDockHostController(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	Floating Form

Returns

Type	Description
DockHostController

GetFloatOnly(Control)

Indicates whether the control is a non-dockable float-only docking window.

Declaration

public bool GetFloatOnly(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Boolean	TRUE if the control is a float-only docking window.

GetFreezeResize(Control)

Specifies whether the docking window should not be resized.

Declaration

public bool GetFreezeResize(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Boolean

GetHiddenOnLoad(Control)

Specifies whether the docking window should be hidden on application startup.

Declaration

public bool GetHiddenOnLoad(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Boolean

GetMaximizeButtonToolTip()

Returns the maximize button's tooltip.

Declaration

public string GetMaximizeButtonToolTip()

Returns

Type	Description
System.String	Text for maximize button tooltip System.String.

GetMDIChildIcon(Control)

Gets the index of the image associated with this docking window at MDI Child state.

Declaration

public int GetMDIChildIcon(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Int32

GetMenuButtonToolTip()

Returns the window position button's tooltip.

Declaration

public string GetMenuButtonToolTip()

Returns

Type	Description
System.String	Text for window position button tooltip System.String.

GetMenuButtonVisibility(Control)

Returns the visibility state for the docking window's window position button.

Declaration

public bool GetMenuButtonVisibility(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
System.Boolean	TRUE if the window position button is displayed. Default is TRUE.

GetMsgProc(Int32, IntPtr, IntPtr)

IGetMsgProcListener implementation

Declaration

public void GetMsgProc(int nCode, IntPtr wparam, IntPtr lparam)

Parameters

Type	Name	Description
System.Int32	nCode
System.IntPtr	wparam	The system message to progress.
System.IntPtr	lparam	The system message to progress.

GetOuterDockAbility(Control)

Indicates where user can dock this control using drag providers (Whidbey and VS2005 drag providers only).

Declaration

public DockAbility GetOuterDockAbility(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.

Returns

Type	Description
DockAbility

GetRestoreButtonToolTip()

Returns the restore button tooltip.

Declaration

public string GetRestoreButtonToolTip()

Returns

Type	Description
System.String	Text for restore button tooltip System.String.

GetSerializedControls(AppStateSerializer)

Returns the serialized controls collection enumerator in the specified Serializer.

Declaration

public IEnumerator GetSerializedControls(AppStateSerializer serializer)

Parameters

Type	Name	Description
AppStateSerializer	serializer

Returns

Type	Description
System.Collections.IEnumerator

GetState(Control)

Returns the current state of the dock child in DockingManager

Declaration

public DockState GetState(Control control)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	Control to get the state

Returns

Type	Description
DockState	Current state of the control

Remarks

By default, GetState returns the state of the control as Dock, even if it is not a child of DockingManager. GetEnableDocking method returns false if the control is not a child of DockingManager.

GetTabbedSiblings(Control)

Returns array of controls which are tabbed with the given control.

Declaration

public Control[] GetTabbedSiblings(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The instance of control whose tabbed siblings are to be returned

Returns

Type	Description
System.Windows.Forms.Control[]	Array of controls

GetTabPosition(Control)

Gets the tab position of the specified control.

Declaration

public int GetTabPosition(Control control)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The instance of a control.

Returns

Type	Description
System.Int32	An Integer value that specifies the tab position of the control.

Remarks

Control must be part of tab group.

GetWindowMode(Control)

Declaration

public WindowMode GetWindowMode(Control dockingChild)

Parameters

Type	Name	Description
System.Windows.Forms.Control	dockingChild

Returns

Type	Description
WindowMode

HasCaptionButtonWithName(String)

Declaration

protected bool HasCaptionButtonWithName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

HideAutoHiddenControl()

Hides the locked autohidden control.

Declaration

public void HideAutoHiddenControl()

HideAutoHiddenControl(Boolean)

Hides the locked autohidden control.

Declaration

public void HideAutoHiddenControl(bool animate)

Parameters

Type	Name	Description
System.Boolean	animate	Indicates whether the locked autohidden control should be hidden with an animation.

Remarks

If an autohidden control is visible and in the locked mode, then invoking this method will unlock and hideItem the control.

HostControl_ControlRemoved(Object, ControlEventArgs)

Declaration

protected void HostControl_ControlRemoved(object sender, ControlEventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.Windows.Forms.ControlEventArgs	e

HostControl_HandleCreated(Object, EventArgs)

Declaration

protected void HostControl_HandleCreated(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	e

HostControl_Layout(Object, LayoutEventArgs)

Declaration

protected void HostControl_Layout(object sender, LayoutEventArgs levent)

Parameters

Type	Name	Description
System.Object	sender
System.Windows.Forms.LayoutEventArgs	levent

HostControl_Paint(Object, PaintEventArgs)

Declaration

protected void HostControl_Paint(object sender, PaintEventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.Windows.Forms.PaintEventArgs	e

HostControl_ParentChanged(Object, EventArgs)

Declaration

protected void HostControl_ParentChanged(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	e

HostControl_RightToLeftChanged(Object, EventArgs)

Declaration

protected void HostControl_RightToLeftChanged(object objSender, EventArgs eaArgs)

Parameters

Type	Name	Description
System.Object	objSender
System.EventArgs	eaArgs

HostControl_SystemColorsChanged(Object, EventArgs)

Declaration

protected void HostControl_SystemColorsChanged(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	e

HostControl_VisibleChanged(Object, EventArgs)

Declaration

protected void HostControl_VisibleChanged(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	e

HostForm_Closed(Object, EventArgs)

Declaration

protected void HostForm_Closed(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	e

HostForm_OnClose(Object, Message)

Declaration

protected void HostForm_OnClose(object sender, Message m)

Parameters

Type	Name	Description
System.Object	sender
System.Windows.Forms.Message	m

ImportControl(DockControllerBase)

Declaration

protected void ImportControl(DockControllerBase dc)

Parameters

Type	Name	Description
DockControllerBase	dc

InitializeCaptionButtons()

Declaration

protected virtual void InitializeCaptionButtons()

InitializeDefaultMenu(DockHostController, PopupMenu)

Declaration

protected virtual void InitializeDefaultMenu(DockHostController dhc, PopupMenu menu)

Parameters

Type	Name	Description
DockHostController	dhc
PopupMenu	menu

InitializeDHCNew(DockHostController, DockControllerBase, DockingStyle, Int32)

Declaration

protected void InitializeDHCNew(DockHostController dhc, DockControllerBase dcbparent, DockingStyle dockstyle, int nsize)

Parameters

Type	Name	Description
DockHostController	dhc
DockControllerBase	dcbparent
DockingStyle	dockstyle
System.Int32	nsize

InitializeDockingManager()

Declaration

protected virtual void InitializeDockingManager()

InitiateFormDrag(FloatingForm, Point, Point)

Declaration

protected void InitiateFormDrag(FloatingForm floatForm, Point ptscreen, Point offset)

Parameters

Type	Name	Description
FloatingForm	floatForm
System.Drawing.Point	ptscreen
System.Drawing.Point	offset

InvalidateDockControllers()

Declaration

protected void InvalidateDockControllers()

IsFloating(Control)

Indicates the dock/float state of the dockable control.

Declaration

public bool IsFloating(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control for which the dock/float state is being queried.

Returns

Type	Description
System.Boolean	TRUE if the control is floating.

IsFrozenToDocumentState(Control)

Indicates whether the control can be dockable or it will remain in document state alone.

Declaration

public bool IsFrozenToDocumentState(Control dockingChild)

Parameters

Type	Name	Description
System.Windows.Forms.Control	dockingChild	The dock-enabled control.

Returns

Type	Description
System.Boolean	TRUE if the control is frozen in document state.

IsMDIMode(Control)

Indicates whether the specified control is in MDI Child mode or not.

Declaration

public bool IsMDIMode(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	Instance of a control.

Returns

Type	Description
System.Boolean	`true` if the specified control is in MDI Child mode; otherwise, `false`.

Remarks

Control must be enabled for docking.

IsSameTabbedGroup(Control, Control)

Determines whether the second control is under the same group of the first control.

Declaration

public virtual bool IsSameTabbedGroup(Control ctrl1, Control ctrl2)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl1	The instance of a control.
System.Windows.Forms.Control	ctrl2	The instance of a control.

Returns

Type	Description
System.Boolean	`true` if the second control is under the first control tab group ; otherwise, `false`.

Remarks

Both controls must be a part of tab group, otherwise it will return false.

IsTabbed(Control)

Indicates whether the specified control is tabbed or not.

Declaration

public bool IsTabbed(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The Instance of a control.

Returns

Type	Description
System.Boolean	`true` if the specified control is tabbed; otherwise, `false`.

Remarks

Control must be enabled for docking.

IterSetSplitterPosition(DockControllerBase, Boolean, Int32)

Declaration

protected bool IterSetSplitterPosition(DockControllerBase dcthis, bool bvertsplitter, int ndelta)

Parameters

Type	Name	Description
DockControllerBase	dcthis
System.Boolean	bvertsplitter
System.Int32	ndelta

Returns

Type	Description
System.Boolean

LoadCaptionButtionsClearedState()

Declaration

protected void LoadCaptionButtionsClearedState()

LoadDesignerDockState()

Restores the dockstate to that set within the visual designer.

Declaration

public bool LoadDesignerDockState()

Returns

Type	Description
System.Boolean	TRUE if the load is successful.

LoadDockState()

Reads the persisted dockstate from the Isolated Storage.

Declaration

public bool LoadDockState()

Returns

Type	Description
System.Boolean	TRUE if the read is successful.

LoadDockState(AppStateSerializer)

Reads a previously serialized dockstate using the AppStateSerializer object.

Declaration

public virtual bool LoadDockState(AppStateSerializer serializer)

Parameters

Type	Name	Description
AppStateSerializer	serializer	A reference to the AppStateSerializer instance.

Returns

Type	Description
System.Boolean	TRUE if the load is successful.

Remarks

Reads the dockstate information from the specified persistent store and applies the new state. This method has been provided only to allow a higher degree of control over the serialization process. For normal state storage and retrieval it is advisable to use the SaveDockState() and LoadDockState() methods.

Examples

//Loading DockState from IsolatedStorage
AppStateSErializer appstser=new AppStateSerializer(SerializeMode.IsolatedStorage, null);
dockingManager1.LoadDockState(appstser);
//Loading DockState from xml file(DockState.xml located in Application folder)
AppStateSerializer appstser =new AppStateSerializer(SerializeMode.XMLFile, "DockState");
dockingManager1.LoadDockState(appstser);

'Loading DockState from IsolatedStorage
Dim appstser As New AppStateSerializer(SerializeMode.IsolatedStorage, Nothing)
dockingManager1.LoadDockState(appstser)
'Loading DockState from xml file(DockState.xml located in Application folder)
Dim appstser As New AppStateSerializer(SerializeMode.XMLFile, "DockState")
dockingManager1.LoadDockState(appstser)

LoadDockState(AppStateSerializer, Control)

Reads a previously serialized dockstate for the specified dockable control and applies the new state.

Declaration

public bool LoadDockState(AppStateSerializer serializer, Control ctrl)

Parameters

Type	Name	Description
AppStateSerializer	serializer	A reference to the AppStateSerializer instance.
System.Windows.Forms.Control	ctrl

Returns

Type	Description
System.Boolean	TRUE if the load is successful.

Remarks

When attempting to read from the store, the LoadDockState method first attempts to locate persisted data pertaining to this control from the stored dockstate information for the DockingManager's full control set and failing that looks for dockstate information that is exclusive to the control. LoadDockState()

LoadDockState(SerializeMode, Object)

Reads a previously serialized dockstate.

Declaration

[Obsolete("This method will be removed in a future version. Please use the more flexible LoadDockState(AppStateSerializer) variant, instead.", false)]
public virtual bool LoadDockState(SerializeMode mode, object persistpath)

Parameters

Type	Name	Description
SerializeMode	mode	A SerializeMode value.
System.Object	persistpath	The name of the IsolatedStorage/INI/XML file or the registry key containing the persisted dockstate information.

Returns

Type	Description
System.Boolean	TRUE if the load is successful.

Remarks

This method will be removed in a future version. Please use the more flexible LoadCommandBarState(AppStateSerializer) variant, instead.

LoadFromStream(Stream)

Declaration

protected bool LoadFromStream(Stream file)

Parameters

Type	Name	Description
System.IO.Stream	file

Returns

Type	Description
System.Boolean

LockDockPanelsUpdate()

Locks panel repainting.

Declaration

public void LockDockPanelsUpdate()

LockHostFormUpdate()

Locks host form's updates.

Declaration

public void LockHostFormUpdate()

Examples

This example shows how to avoid flickering during loading a dockstate

dockingManager1.LockHostFormUpdate();
dockingManager1.LoadDockState();
dockingManager1.UnlockHostFormUpdate();

DockingManager1.LockHostFormUpdate()
DockingManager1.LoadDockState()
DockingManager1.UnlockHostFormUpdate()

MaximizeControl(Control)

Maximizes the specified dockable control.

Declaration

public void MaximizeControl(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control instance.

MDIFormDockableItem_Click(Object, EventArgs)

Declaration

protected void MDIFormDockableItem_Click(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	e

MDIFormFloatingItem_Click(Object, EventArgs)

Declaration

protected void MDIFormFloatingItem_Click(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	e

MDIFormHideItem_Click(Object, EventArgs)

Declaration

protected void MDIFormHideItem_Click(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	e

OnAutoHideAnimationStart(AutoHideAnimationEventArgs)

Raises the AutoHideAnimationStart event.

Declaration

protected virtual void OnAutoHideAnimationStart(AutoHideAnimationEventArgs arg)

Parameters

Type	Name	Description
AutoHideAnimationEventArgs	arg	A AutoHideAnimationEventArgs that contains the event data.

OnAutoHideAnimationStop(AutoHideAnimationEventArgs)

Raises the AutoHideAnimationStop event.

Declaration

protected virtual void OnAutoHideAnimationStop(AutoHideAnimationEventArgs arg)

Parameters

Type	Name	Description
AutoHideAnimationEventArgs	arg	A AutoHideAnimationEventArgs that contains the event data.

OnAutoHideTabContextMenu(AutoHideTabContextMenuEventArgs)

Raises the AutoHideTabContextMenu event.

Declaration

protected virtual void OnAutoHideTabContextMenu(AutoHideTabContextMenuEventArgs ahcmenuargs)

Parameters

Type	Name	Description
AutoHideTabContextMenuEventArgs	ahcmenuargs	A that contains the event data.

OnControlMaximized(ControlMaximizedEventArgs)

Raises the ControlMaximized event.

Declaration

protected virtual void OnControlMaximized(ControlMaximizedEventArgs args)

Parameters

Type	Name	Description
ControlMaximizedEventArgs	args	A ControlMaximizeEventArgs that contains the event data.

OnControlMaximizing(ControlMaximizeEventArgs)

Raises the ControlMaximizing event.

Declaration

protected virtual void OnControlMaximizing(ControlMaximizeEventArgs args)

Parameters

Type	Name	Description
ControlMaximizeEventArgs	args	A ControlMaximizeEventArgs that contains the event data.

OnControlMinimized(ControlMinimizedEventArgs)

Raises the ControlMinimized event.

Declaration

protected virtual void OnControlMinimized(ControlMinimizedEventArgs args)

Parameters

Type	Name	Description
ControlMinimizedEventArgs	args	A ControlMinimizedEventArgs that contains the event data.

OnControlRestored(ControlRestoredEventArgs)

Raises the ControlRestored event.

Declaration

protected virtual void OnControlRestored(ControlRestoredEventArgs args)

Parameters

Type	Name	Description
ControlRestoredEventArgs	args	A ControlRestoredEventArgs that contains the event data.

OnDockAllow(DockAllowEventArgs)

Raises the DockAllow event.

Declaration

protected virtual void OnDockAllow(DockAllowEventArgs arg)

Parameters

Type	Name	Description
DockAllowEventArgs	arg	A DockAllowEventArgs that contains the event data.

OnDockContextMenu(DockContextMenuEventArgs)

Raises the DockContextMenu event.

Declaration

protected virtual void OnDockContextMenu(DockContextMenuEventArgs arg)

Parameters

Type	Name	Description
DockContextMenuEventArgs	arg	A DockContextMenuEventArgs that contains the event data.

OnDockControlActivated(DockActivationChangedEventArgs)

Raises the DockControlActivated event.

Declaration

protected virtual void OnDockControlActivated(DockActivationChangedEventArgs arg)

Parameters

Type	Name	Description
DockActivationChangedEventArgs	arg	A DockActivationChangedEventArgs that contains the event data.

OnDockControlDeactivated(DockActivationChangedEventArgs)

Raises the DockControlDeactivated event.

Declaration

protected virtual void OnDockControlDeactivated(DockActivationChangedEventArgs arg)

Parameters

Type	Name	Description
DockActivationChangedEventArgs	arg	A DockActivationChangedEventArgs that contains the event data.

OnDockMenuClick(DockMenuClickEventArgs)

Raises the DockMenuClick event.

Declaration

protected virtual void OnDockMenuClick(DockMenuClickEventArgs arg)

Parameters

Type	Name	Description
DockMenuClickEventArgs	arg	A DockMenuClickEventArgs that contains the event data.

OnDockStateChanged(DockStateChangeEventArgs)

Raises the DockStateChanged event.

Declaration

protected virtual void OnDockStateChanged(DockStateChangeEventArgs arg)

Parameters

Type	Name	Description
DockStateChangeEventArgs	arg	A DockStateChangeEventArgs that contains the event data.

OnDockStateChanging(DockStateChangeEventArgs)

Raises the DockStateChanging event.

Declaration

protected virtual void OnDockStateChanging(DockStateChangeEventArgs arg)

Parameters

Type	Name	Description
DockStateChangeEventArgs	arg	A DockStateChangeEventArgs that contains the event data.

OnDockStateUnavailable(DockStateUnavailableEventArgs)

Raises the DockStateUnavailable event.

Declaration

protected virtual void OnDockStateUnavailable(DockStateUnavailableEventArgs arg)

Parameters

Type	Name	Description
DockStateUnavailableEventArgs	arg	A DockStateUnavailableEventArgs that contains the event data.

OnDockVisibilityChanged(DockVisibilityChangedEventArgs)

Raises the DockVisibilityChanged event.

Declaration

protected virtual void OnDockVisibilityChanged(DockVisibilityChangedEventArgs arg)

Parameters

Type	Name	Description
DockVisibilityChangedEventArgs	arg	A DockVisibilityChangedEventArgs that contains the event data.

OnDockVisibilityChanging(DockVisibilityChangingEventArgs)

Raises the DockVisibilityChanging event.

Declaration

protected virtual bool OnDockVisibilityChanging(DockVisibilityChangingEventArgs arg)

Parameters

Type	Name	Description
DockVisibilityChangingEventArgs	arg	A DockVisibilityChangingEventArgs that contains the event data.

Returns

Type	Description
System.Boolean

OnDragAllow(DragAllowEventArgs)

Raises the DragAllow event.

Declaration

protected virtual void OnDragAllow(DragAllowEventArgs arg)

Parameters

Type	Name	Description
DragAllowEventArgs	arg	A DragAllowEventArgs that contains the event data.

OnDragFeedbackStart(EventArgs)

Raises the DragFeedbackStart event.

Declaration

protected virtual void OnDragFeedbackStart(EventArgs arg)

Parameters

Type	Name	Description
System.EventArgs	arg	An System.EventArgs that contains the event data.

OnDragFeedbackStop(EventArgs)

Raises the DragFeedbackStop event.

Declaration

protected virtual void OnDragFeedbackStop(EventArgs arg)

Parameters

Type	Name	Description
System.EventArgs	arg	An System.EventArgs that contains the event data.

OnImageListChanged(EventArgs)

Raises the ImageListChanged event.

Declaration

protected virtual void OnImageListChanged(EventArgs arg)

Parameters

Type	Name	Description
System.EventArgs	arg	An EventArgs that contains the event data.

OnInitializeControlOnLoad(InitializeControlOnLoadEventArgs)

Raises the InitializeControlOnLoad event.

Declaration

protected void OnInitializeControlOnLoad(InitializeControlOnLoadEventArgs args)

Parameters

Type	Name	Description
InitializeControlOnLoadEventArgs	args	A InitializeControlOnLoadEventArgs value that contains the event data.

OnMenuAutoHide_Click(Object, EventArgs)

Declaration

protected void OnMenuAutoHide_Click(object sender, EventArgs arg)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	arg

OnMenuDockable_Click(Object, EventArgs)

Declaration

protected void OnMenuDockable_Click(object sender, EventArgs arg)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	arg

OnMenuDockToBottom_Click(Object, EventArgs)

Declaration

protected void OnMenuDockToBottom_Click(object sender, EventArgs arg)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	arg

OnMenuDockToLeft_Click(Object, EventArgs)

Declaration

protected void OnMenuDockToLeft_Click(object sender, EventArgs arg)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	arg

OnMenuDockToRight_Click(Object, EventArgs)

Declaration

protected void OnMenuDockToRight_Click(object sender, EventArgs arg)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	arg

OnMenuDockToTop_Click(Object, EventArgs)

Declaration

protected void OnMenuDockToTop_Click(object sender, EventArgs arg)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	arg

OnMenuFloat_Click(Object, EventArgs)

Declaration

protected void OnMenuFloat_Click(object sender, EventArgs arg)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	arg

OnMenuHide_Click(Object, EventArgs)

Declaration

protected void OnMenuHide_Click(object sender, EventArgs arg)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	arg

OnMenuMDIChild_Click(Object, EventArgs)

Declaration

protected void OnMenuMDIChild_Click(object sender, EventArgs arg)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	arg

OnNewDockStateBeginLoad(EventArgs)

Raises the NewDockStateBeginLoad event.

Declaration

protected virtual void OnNewDockStateBeginLoad(EventArgs arg)

Parameters

Type	Name	Description
System.EventArgs	arg	An System.EventArgs that contains the event data.

OnNewDockStateEndLoad(EventArgs)

Raises the NewDockStateEndLoad event.

Declaration

protected virtual void OnNewDockStateEndLoad(EventArgs arg)

Parameters

Type	Name	Description
System.EventArgs	arg	An System.EventArgs that contains the event data.

OnProvideGraphicsItems(ProvideGraphicsItemsEventArgs)

Raises the ProvideGraphicsItems event.

Declaration

protected virtual void OnProvideGraphicsItems(ProvideGraphicsItemsEventArgs arg)

Parameters

Type	Name	Description
ProvideGraphicsItemsEventArgs	arg	A that contains the event data.

OnProvidePresistenceID(ProvidePersistenceIDEventArgs)

Raises the ProvidePersistenceID event.

Declaration

protected virtual void OnProvidePresistenceID(ProvidePersistenceIDEventArgs e)

Parameters

Type	Name	Description
ProvidePersistenceIDEventArgs	e	An ProvidePersistenceIDEventArgs object containing data pertaining to this event.

Remarks

The OnProvidePresistenceID method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors: When overriding OnProvidePresistenceID in a derived class, be sure to call the base class's OnProvidePresistenceID method so that registered delegates receive the event.

OnThemeNameChanged(String)

Helps to override the ThemeName property settings

Declaration

public override void OnThemeNameChanged(string themeName)

Parameters

Type	Name	Description
System.String	themeName	ThemeName

Overrides

BaseComponent.OnThemeNameChanged(String)

OnTransferredToManager(TransferManagerEventArgs)

Raises the TransferredToManager event.

Declaration

protected void OnTransferredToManager(TransferManagerEventArgs args)

Parameters

Type	Name	Description
TransferManagerEventArgs	args	A TransferManagerEventArgs that contains the event data.

OnTransferringFromManager(TransferManagerEventArgs)

Raises the TransferringFromManager event.

Declaration

protected void OnTransferringFromManager(TransferManagerEventArgs args)

Parameters

Type	Name	Description
TransferManagerEventArgs	args	A TransferManagerEventArgs that contains the event data.

OwnerForm_HandleCreated(Object, EventArgs)

Declaration

protected void OwnerForm_HandleCreated(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender
System.EventArgs	e

ProcessDockToClick(Object, DockingStyle)

Declaration

protected void ProcessDockToClick(object sender, DockingStyle dockstyle)

Parameters

Type	Name	Description
System.Object	sender
DockingStyle	dockstyle

RaiseEnabledDocking(Control, Boolean)

Declaration

protected void RaiseEnabledDocking(Control ctrl, bool enabledDocking)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl
System.Boolean	enabledDocking

ReArrangeControl(DockControllerBase, ArrayList, DockHostController)

Declaration

protected bool ReArrangeControl(DockControllerBase parent, ArrayList controls, DockHostController dhc)

Parameters

Type	Name	Description
DockControllerBase	parent
System.Collections.ArrayList	controls
DockHostController	dhc

Returns

Type	Description
System.Boolean

ReArrangeControls(DockControllerBase, ArrayList)

Declaration

protected DockControllerBase ReArrangeControls(DockControllerBase parent, ArrayList controls)

Parameters

Type	Name	Description
DockControllerBase	parent
System.Collections.ArrayList	controls

Returns

Type	Description
DockControllerBase

RecalcHostFormLayout()

Forces the host form to recalculate it's layout.

Declaration

public void RecalcHostFormLayout()

RecSubscribeHostControlEvents(Control, Boolean)

Declaration

protected void RecSubscribeHostControlEvents(Control ctrl, bool subscribe)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl
System.Boolean	subscribe

RecurseChildController(DockControllerBase, Point)

Declaration

protected DockControllerBase RecurseChildController(DockControllerBase dc, Point pt)

Parameters

Type	Name	Description
DockControllerBase	dc
System.Drawing.Point	pt

Returns

Type	Description
DockControllerBase

RedockDockTabControl(DockTabController, Control, DockingStyle, Int32)

Declaration

protected void RedockDockTabControl(DockTabController dtc, Control parent, DockingStyle dockstyle, int nsize)

Parameters

Type	Name	Description
DockTabController	dtc
System.Windows.Forms.Control	parent
DockingStyle	dockstyle
System.Int32	nsize

RemoveControllerFromDockingManager(DockHostController)

Serves to remove the specified controller from the docking manager.

Declaration

public void RemoveControllerFromDockingManager(DockHostController dhc)

Parameters

Type	Name	Description
DockHostController	dhc	The Dock host controller

RemoveDockHostImageFromList(DockHostController)

Declaration

protected void RemoveDockHostImageFromList(DockHostController dhcontroller)

Parameters

Type	Name	Description
DockHostController	dhcontroller

RemoveFromTargetManagersList(DockingManager)

Removes the DockingManager from the target providers list belonging to the current manager.

Declaration

public void RemoveFromTargetManagersList(DockingManager dockingmgr)

Parameters

Type	Name	Description
DockingManager	dockingmgr	The DockingManager to be removed from the target list.

Remarks

Specifying a DockingManager as a target provider by adding it to another DockingManager's target list allows controls from the source manager to be dragged and docked onto the docking layout hosted by the target manager. AddToTargetManagersList(DockingManager) TransferringFromManager TransferredToManager

ResetActiveCaptionButtonForeColor()

Resets the DockBehavior CaptionButtonForeColor to it's default value.

Declaration

public void ResetActiveCaptionButtonForeColor()

ResetActiveControl()

Resets the active control in docking manager. It is preferable to handle this call in AutoHideAnimationStop event

Declaration

public void ResetActiveControl()

ResetAutoHideTabFont()

Resets the AutoHideTabFont property to it's default value.

Declaration

public void ResetAutoHideTabFont()

ResetAutoHideTabForeColor()

Resets the AutoHideTabForeColor property to it's default value.

Declaration

public void ResetAutoHideTabForeColor()

ResetAutoHideTabHeight()

Resets the AutoHideTabHeight property to it's default value.

Declaration

public void ResetAutoHideTabHeight()

ResetBrowsingKey()

Resets the BrowsingKey value.

Declaration

public void ResetBrowsingKey()

ResetCaptionButtons()

Resets the CaptionButtons value.

Declaration

public void ResetCaptionButtons()

ResetCaptionHeight()

Declaration

protected void ResetCaptionHeight()

ResetDockBehavior()

Resets the DockBehavior property to it's default value.

Declaration

public void ResetDockBehavior()

ResetDockTabFont()

Resets the DockTabFont property to it's default value.

Declaration

public void ResetDockTabFont()

ResetDockTabForeColor()

Resets the DockTabForeColor property to it's default value.

Declaration

public void ResetDockTabForeColor()

ResetDockTabHeight()

Resets the DockTabHeight property to it's default value.

Declaration

public void ResetDockTabHeight()

ResetDockTabPadX()

Resets the DockTabPadX property to it's default value.

Declaration

public void ResetDockTabPadX()

ResetEnableAutoAdjustCaption()

Resets the EnableAutoAdjustCaption property to it's default value.

Declaration

public void ResetEnableAutoAdjustCaption()

ResetEnableDocumentMode()

Resets the EnableDocumentMode property to it's default value.

Declaration

protected bool ResetEnableDocumentMode()

Returns

Type	Description
System.Boolean

ResetInActiveCaptionButtonForeColor()

Resets the DockBehavior CaptionButtonForeColor to it's default value.

Declaration

public void ResetInActiveCaptionButtonForeColor()

ResetMetroCaptionColor()

Resets the MetroCaptionColor property to it's default value.

Declaration

public void ResetMetroCaptionColor()

ResetMetroInactiveCaptionColor()

Resets the MetroInactiveCaptionColor property to it's default value.

Declaration

public void ResetMetroInactiveCaptionColor()

ResetShowCustomButtonsInFloating()

Declaration

protected void ResetShowCustomButtonsInFloating()

ResetShowMetroCaptionLines()

Resets the ShowMetroCaptionDottedLines property to it's default value.

Declaration

public void ResetShowMetroCaptionLines()

RestoreControl(Control)

Restores the specified dockable control.

Declaration

public void RestoreControl(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control instance.

RestoreFloatingForms()

Declaration

protected void RestoreFloatingForms()

RestoreMdiZOrder(ArrayList)

Declaration

protected void RestoreMdiZOrder(ArrayList list)

Parameters

Type	Name	Description
System.Collections.ArrayList	list

RestrictDockFillAutoHideBorder(DockingStyle)

Restricts dock fill auto hide border.

Declaration

public void RestrictDockFillAutoHideBorder(DockingStyle style)

Parameters

Type	Name	Description
DockingStyle	style	The DockingStyle

ResumeHooks()

Resumes listening to system wide hooks.

Declaration

public void ResumeHooks()

ResumeLayout()

Call this so that the DockingManager can continue to layout elements on the form (if it was previously suspended).

Declaration

public void ResumeLayout()

ResumeLayout(Boolean)

Call this so that the DockingManager can continue to layout elements on the form (if it was previously suspended).

Declaration

public void ResumeLayout(bool bRefresh)

Parameters

Type	Name	Description
System.Boolean	bRefresh

SaveCaptionButtionsClearedState()

Declaration

protected void SaveCaptionButtionsClearedState()

SaveDockState()

Overloaded. Saves the current dockstate to Isolated Storage.

Declaration

public void SaveDockState()

SaveDockState(AppStateSerializer)

Saves the current dockstate information to the specified AppStateSerializer.

Declaration

public virtual void SaveDockState(AppStateSerializer serializer)

Parameters

Type	Name	Description
AppStateSerializer	serializer	A reference to the AppStateSerializer instance.

Remarks

Writes the docking windows information to the persistence medium. This method has been provided only to allow a higher degree of control over the serialization process. For normal state storage and retrieval it is advisable to use the SaveDockState() and LoadDockState() methods.

Examples

//Saving DockState to IsolatedStorage
AppStateSErializer appstser=new AppStateSerializer(SerializeMode.IsolatedStorage, null);
dockingManager1.SaveDockState(appstser);
appstser.PersistNow();
//Saving DockState to xml file(DockState.xml located in Application folder)
AppStateSerializer appstser =new AppStateSerializer(SerializeMode.XMLFile, "DockState");
dockingManager1.SaveDockState(appstser);
appstser.PersistNow();

'Saving DockState to IsolatedStorage
Dim appstser As New AppStateSerializer(SerializeMode.IsolatedStorage, Nothing)
dockingManager1.SaveDockState(appstser)
appstser.PersistNow()
'Saving DockState to xml file(DockState.xml located in Application folder)
Dim appstser As New AppStateSerializer(SerializeMode.XMLFile, "DockState")
dockingManager1.SaveDockState(appstser)
appstser.PersistNow()

SaveDockState(AppStateSerializer, Control)

Saves the dockstate information for the specified dockable control.

Declaration

public void SaveDockState(AppStateSerializer serializer, Control ctrl)

Parameters

Type	Name	Description
AppStateSerializer	serializer	A reference to the AppStateSerializer instance.
System.Windows.Forms.Control	ctrl

Remarks

Takes a snapshot of the control's current dock state in the DockingManager's layout and serializes this information to the persistence medium set in the AppStateSerializer. SaveDockState() LoadDockState()

SaveDockState(SerializeMode, Object)

Saves the current dockstate information to the specified persistence medium.

Declaration

[Obsolete("This method will be removed in a future version. Please use the more flexible SaveDockState(AppStateSerializer) variant, instead.", false)]
public virtual void SaveDockState(SerializeMode mode, object persistpath)

Parameters

Type	Name	Description
SerializeMode	mode	A SerializeMode value.
System.Object	persistpath	Specifies the name of an IsolatedStorage/INI/XML file or a registry key to which the persistence information will be written.

Remarks

Writes the docking windows information to the persistence medium specified by the mode parameter and at the path specified by the persistpath object. This method has been provided only to allow a higher degree of control over the serialization process. For normal state storage and retrieval it is advisable to use the SaveDockState() and LoadDockState() methods.

This method will be removed in a future version. Please use the more flexible SaveDockState(AppStateSerializer) variant, instead.

SearchWrappers(ArrayList, DockHostController)

Declaration

protected bool SearchWrappers(ArrayList wr, DockHostController dhc)

Parameters

Type	Name	Description
System.Collections.ArrayList	wr
DockHostController	dhc

Returns

Type	Description
System.Boolean

SetActiveControl(Control)

Declaration

protected void SetActiveControl(Control ctrl)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl

SetAllowFloating(Control, Boolean)

Sets if the control can transit to floating state.

Declaration

public void SetAllowFloating(Control ctrl, bool bfloating)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	bfloating	TRUE to allow floating.

SetAsMDIChild(Control, Boolean)

Sets the control as an MDI child.

Declaration

public virtual void SetAsMDIChild(Control ctrl, bool bsetmdi)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock enabled control.
System.Boolean	bsetmdi	Indicates whether the docked control is specified as MDI or not.

SetAsMDIChild(Control, Boolean, Rectangle)

Sets the control as an MDI child.

Declaration

public virtual void SetAsMDIChild(Control ctrl, bool bsetmdi, Rectangle layout)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock enabled control.
System.Boolean	bsetmdi	Indicates whether the docked control is specified as MDI or not.
System.Drawing.Rectangle	layout	The Rectangle for the MDI child.

SetAutoHideButtonToolTip(String)

Sets the auto hide button's tooltip.

Declaration

public void SetAutoHideButtonToolTip(string text)

Parameters

Type	Name	Description
System.String	text	Tooltip text.

SetAutoHideButtonVisibility(Control, Boolean)

Sets the visibility state for the docking window's autohide button.

Declaration

public void SetAutoHideButtonVisibility(Control ctrl, bool bvisible)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	bvisible	TRUE to display the autohide button. Default is TRUE.

SetAutoHideMode(Control, Boolean)

Transfers the dockable control into or out of the autohide mode.

Declaration

public void SetAutoHideMode(Control ctrl, bool bautohide)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	bautohide	Indicates whether the control is set in autohide mode.

SetAutoHideMode(Control, Boolean, Boolean)

Transfers the dockable control into or out of the autohide mode.

Declaration

public void SetAutoHideMode(Control ctrl, bool autoHide, bool singleOperate)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	autoHide
System.Boolean	singleOperate	Indicates whether only the specified control should go into autohide mode, if tabbed.

SetAutoHideOnLoad(Control, Boolean)

Specifies whether the docking window should be in the autohide mode on application startup.

Declaration

public void SetAutoHideOnLoad(Control ctrl, bool bautohide)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	bautohide	Indicates whether the control is in Auto hide on application start up.

SetCloseButtonToolTip(String)

Sets the close button's tooltip.

Declaration

public void SetCloseButtonToolTip(string text)

Parameters

Type	Name	Description
System.String	text	Tooltip text.

SetCloseButtonVisibility(Control, Boolean)

Sets the visibility state for the docking window's close button.

Declaration

public void SetCloseButtonVisibility(Control ctrl, bool bvisible)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	bvisible	TRUE to display the close button. Default is TRUE.

SetControlMinimumSize(Control, Size)

Specifies the minimum width and height to which the dockable control can be resized to.

Declaration

public void SetControlMinimumSize(Control ctrl, Size minsize)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The docking window.
System.Drawing.Size	minsize	A System.Drawing.Size value specifying the minimum bounds. Default value is Size.Empty.

Remarks

The SetControlMinimumSize method is a part of the DockingManager's programmatic API and is not exposed by the docking windows designer. The application should invoke this method for each dock-enabled control that requires a set minimum size. The best place to call this method is from a handler for the NewDockStateEndLoad event.

Please note that the control's minimum bounds are only a hint. While the DockingManager will enforce the set extents far as possible, layout constraints may at times force it to overrun the minimum size.

SetControlSize(Control, Size)

Sets a new size for the dockable control.

Declaration

public void SetControlSize(Control ctrl, Size newsize)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The docked/floating control.
System.Drawing.Size	newsize	Specifies the new size of the control.

Remarks

The SetControlSize method changes the dimensions of the docked control by displacing the horizontal/vertical splitter that is closest to the particular control.

SetCustomCaptionButtons(Control, CaptionButtonsCollection)

Sets custom caption buttons collection for each docked control.

Declaration

public void SetCustomCaptionButtons(Control ctrl, CaptionButtonsCollection buttons)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
CaptionButtonsCollection	buttons	The CaptionButtonsCollection.

SetDockAbility(Control, DockAbility)

Indicates where user can dock in this control using drag providers (Arrow drag providers only).

Declaration

public void SetDockAbility(Control ctrl, DockAbility ability)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
DockAbility	ability	The DockAbility of the control.

SetDockAbility(Control, Int32)

Specifies where user can dock in this control using drag providers (Arrow drag providers only).

Declaration

public void SetDockAbility(Control ctrl, int nAbility)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Int32	nAbility	The index of the DockAbility.

SetDockAbility(Control, String)

Indicates where user can dock in this control using drag providers (Arrow drag providers only).

Declaration

public void SetDockAbility(Control ctrl, string strAbility)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.String	strAbility	The DockAbility.

SetDockIcon(Control, Icon)

Sets the Image associated with the docking window.

Declaration

public void SetDockIcon(Control ctrl, Icon image)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock enabled control.
System.Drawing.Icon	image	The System.Drawing.Icon representing the docking window.

Remarks

This overloaded version of the SetDockIcon(Control, Int32) method is normally used only in combination with the ControlScopeImages property. Setting ControlScopeImages to TRUE signifies that dockable controls will provide their own images objects during initialization and the scope of these images will be restricted to the control's existence as a docking window. ControlScopeImages

SetDockIcon(Control, Int32)

Returns the index of the image associated with the docking window.

Declaration

public void SetDockIcon(Control ctrl, int index)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Int32	index	A zero-based index into the ImageList property value.

SetDockLabel(Control, String)

Sets the text to be displayed in the docking window caption.

Declaration

public void SetDockLabel(Control ctrl, string strtext)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.String	strtext	A String value representing the text caption.

SetDockVisibility(Control, Boolean)

Sets the docking window's visibility state.

Declaration

public void SetDockVisibility(Control ctrl, bool bvisible)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control for which the DockVisibility is to be set.
System.Boolean	bvisible	TRUE indicates that the control will be a part of the current dockset. Else the control will be closed. Clicking the 'X' button sets the DockVisibility to be false.

Remarks

A control's DockVisibility indicates whether the control is currently 'closed' or is an active participant of the interactions within the current set of docking windows. This is different from the Control.Visible property as a dockable control that is not visible may still be a part of the docking implementation such as when it is in the autohide or tabbed docking modes.

SetDockVisibility(Control, Boolean, Point)

Sets the docking window's visibility state.

Declaration

public void SetDockVisibility(Control ctrl, bool bvisible, Point floatingLocation)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control for which the DockVisibility is to be set.
System.Boolean	bvisible	TRUE indicates that the control will be a part of the current dockset. Else the control will be closed. Clicking the 'X' button sets the DockVisibility to be false.
System.Drawing.Point	floatingLocation	Location whether the floating form need to be displayed, in case of floating control

Remarks

SetEnableDocking(Control, Boolean)

Enables or disables the control as a docking window.

Declaration

public void SetEnableDocking(Control ctrl, bool value)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The control instance.
System.Boolean	value	TRUE indicates that the control is set as a docking window; FALSE to disable a dock-enabled control.

SetFloatOnly(Control, Boolean)

Sets the control as a non-dockable float-only window.

Declaration

public void SetFloatOnly(Control ctrl, bool bfloating)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	bfloating	TRUE to disable docking.

SetFreezeResize(Control, Boolean)

Specifies whether the docking window should not be resized.

Declaration

public void SetFreezeResize(Control ctrl, bool freeze)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	freeze	Indicates whether the docking window should not be resized.

SetHiddenOnLoad(Control, Boolean)

Specifies whether the docking window should be hidden on application startup.

Declaration

public void SetHiddenOnLoad(Control ctrl, bool bhidden)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	bhidden	Indicates whether the control is in Auto hide on application start up.

SetIsMirrored(Control, Boolean)

Sets the RTL property for the specified control.

Declaration

public void SetIsMirrored(Control ctrl, bool bRTL)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	bRTL	TRUE indicates that the control is set as Mirrored; FALSE to disable Mirrored for a specified control.

SetMaximizeButtonToolTip(String)

Sets the maximize button's tooltip.

Declaration

public void SetMaximizeButtonToolTip(string text)

Parameters

Type	Name	Description
System.String	text	Tooltip text.

SetMDIChildIcon(Control, Icon)

Sets the index of the image associated with this docking window at MDI Child state.

Declaration

public void SetMDIChildIcon(Control ctrl, Icon image)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Drawing.Icon	image	The icon of the MDI child.

SetMDIChildIcon(Control, Int32)

Sets the index of the image associated with this docking window at MDI Child state.

Declaration

public void SetMDIChildIcon(Control ctrl, int index)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Int32	index	The index of the Mdi child.

SetMenuButtonToolTip(String)

Sets the window position button's tooltip.

Declaration

public void SetMenuButtonToolTip(string text)

Parameters

Type	Name	Description
System.String	text	Tooltip text.

SetMenuButtonVisibility(Control, Boolean)

Sets the visibility state for the docking window's window position button.

Declaration

public void SetMenuButtonVisibility(Control ctrl, bool bvisible)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Boolean	bvisible	TRUE to display the window position button. Default is TRUE.

SetOuterDockAbility(Control, DockAbility)

Indicates where user can dock this control using drag providers (Arrow drag providers only).

Declaration

public void SetOuterDockAbility(Control ctrl, DockAbility ability)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
DockAbility	ability	The DockAbility of the control

SetOuterDockAbility(Control, Int32)

Specifies where user can dock this control using drag providers (Arrow drag providers only).

Declaration

public void SetOuterDockAbility(Control ctrl, int nAbility)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.Int32	nAbility	The index of the DockAbility.

SetOuterDockAbility(Control, String)

Indicates where user can dock this control using drag providers (Whidbey and VS2005 drag providers only).

Declaration

public void SetOuterDockAbility(Control ctrl, string strAbility)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock-enabled control.
System.String	strAbility	The DockAbility.

SetRestoreButtonToolTip(String)

Sets the restore button tooltip.

Declaration

public void SetRestoreButtonToolTip(string text)

Parameters

Type	Name	Description
System.String	text	Tooltip text.

SetTabPosition(Control, Int32)

Sets the docked control's position within tab group.

Declaration

public void SetTabPosition(Control control, int newPosition)

Parameters

Type	Name	Description
System.Windows.Forms.Control	control	The control instance.
System.Int32	newPosition	New position of control's page.

Remarks

Control must be part of tab group. newPosition must be valid page index of tab group.

SetToolTip(Control, String)

Set header tooltip for a docking child element.

Declaration

public void SetToolTip(Control ctrl, string tooltipText)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	To get ChildElements
System.String	tooltipText	To get ToolTipTex for that corresponding ChildElements

SetWindowMode(Control, WindowMode)

Set the window mode of docking child that defines dockability for specific child in DockingManager.

Declaration

public void SetWindowMode(Control dockingChild, WindowMode windowMode)

Parameters

Type	Name	Description
System.Windows.Forms.Control	dockingChild	The control to be dock based on WindowMode.
WindowMode	windowMode	Specifies the WindowMode for docking child

ShouldSerializeActiveCaptionFont()

Indicates whether the current value of the ActiveCaptionFont property is to be serialized.

Declaration

protected bool ShouldSerializeActiveCaptionFont()

Returns

Type	Description
System.Boolean

ShouldSerializeActiveDockTabBackColor()

Indicates whether the current value of the ActiveDockTabBackColor property is to be serialized.

Declaration

protected bool ShouldSerializeActiveDockTabBackColor()

Returns

Type	Description
System.Boolean

ShouldSerializeActiveDockTabForeColor()

Indicates whether the current value of the ActiveDockTabForeColor property is to be serialized.

Declaration

protected bool ShouldSerializeActiveDockTabForeColor()

Returns

Type	Description
System.Boolean

ShouldSerializeAutoHideTabFont()

Declaration

protected bool ShouldSerializeAutoHideTabFont()

Returns

Type	Description
System.Boolean

ShouldSerializeAutoHideTabForeColor()

Indicates whether the current value of the AutoHideTabForeColor property is to be serialized.

Declaration

protected bool ShouldSerializeAutoHideTabForeColor()

Returns

Type	Description
System.Boolean

ShouldSerializeAutoHideTabHeight()

Declaration

protected bool ShouldSerializeAutoHideTabHeight()

Returns

Type	Description
System.Boolean

ShouldSerializeCaptionHeight()

Indicates whether the current value of the CaptionHeight property is to be serialized.

Declaration

protected bool ShouldSerializeCaptionHeight()

Returns

Type	Description
System.Boolean

ShouldSerializeDockBehavior()

Declaration

protected bool ShouldSerializeDockBehavior()

Returns

Type	Description
System.Boolean

ShouldSerializeDockedCaptionFont()

Indicates whether the current value of the DockedCaptionFont property is to be serialized.

Declaration

protected bool ShouldSerializeDockedCaptionFont()

Returns

Type	Description
System.Boolean

ShouldSerializeDockTabBackColor()

Indicates whether the current value of the DockTabBackColor property is to be serialized.

Declaration

protected bool ShouldSerializeDockTabBackColor()

Returns

Type	Description
System.Boolean

ShouldSerializeDockTabFont()

Declaration

protected bool ShouldSerializeDockTabFont()

Returns

Type	Description
System.Boolean

ShouldSerializeDockTabForeColor()

Indicates whether the current value of the DockTabForeColor property is to be serialized.

Declaration

protected bool ShouldSerializeDockTabForeColor()

Returns

Type	Description
System.Boolean

ShouldSerializeDockTabHeight()

Declaration

protected bool ShouldSerializeDockTabHeight()

Returns

Type	Description
System.Boolean

ShouldSerializeDockTabPadX()

Indicates whether the current value of the DockTabPadX property is to be serialized.

Declaration

protected bool ShouldSerializeDockTabPadX()

Returns

Type	Description
System.Boolean	The value of the docked tab control padding.

ShouldSerializeDockTabPanelBackColor()

Indicates whether the current value of the DockTabPanelBackColor property is to be serialized.

Declaration

protected bool ShouldSerializeDockTabPanelBackColor()

Returns

Type	Description
System.Boolean

ShouldSerializeDockTabSeparatorColor()

Indicates whether the current value of the DockTabSeparatorColor property is to be serialized.

Declaration

protected bool ShouldSerializeDockTabSeparatorColor()

Returns

Type	Description
System.Boolean

ShouldSerializeEnableAutoAdjustCaption()

Indicates whether the current value of the EnableAutoAdjustCaption property is to be serialized.

Declaration

public bool ShouldSerializeEnableAutoAdjustCaption()

Returns

Type	Description
System.Boolean

ShouldSerializeEnableDocumentMode()

Indicates whether the current value of the EnableDocumentMode property is to be serialized.

Declaration

protected bool ShouldSerializeEnableDocumentMode()

Returns

Type	Description
System.Boolean

ShouldSerializeInActiveCaptionFont()

Indicates whether the current value of the InActiveCaptionFont property is to be serialized.

Declaration

protected bool ShouldSerializeInActiveCaptionFont()

Returns

Type	Description
System.Boolean

ShouldSerializeMetroCaptionColor()

Indicates whether the current value of the MetroCaptionColor property is to be serialized.

Declaration

protected bool ShouldSerializeMetroCaptionColor()

Returns

Type	Description
System.Boolean

ShouldSerializeMetroInactiveCaptionColor()

Indicates whether the current value of the MetroInactiveCaptionColor property is to be serialized.

Declaration

protected bool ShouldSerializeMetroInactiveCaptionColor()

Returns

Type	Description
System.Boolean

ShouldSerializeShowCustomButtonsInFloating()

Declaration

protected bool ShouldSerializeShowCustomButtonsInFloating()

Returns

Type	Description
System.Boolean

ShouldSerializeShowMetroCaptionLines()

Indicates whether the current value of the ShowMetroCaptionDottedLines property is to be serialized.

Declaration

protected bool ShouldSerializeShowMetroCaptionLines()

Returns

Type	Description
System.Boolean	The value of the ShowMetroCaptionLines.

ShowMenu(DockHostController, Point)

If contextmenu is enabled, then displays the Syncfusion XP menus. Else fires the contextmenu event with a null popup menu.

Declaration

public void ShowMenu(DockHostController dhc, Point pt)

Parameters

Type	Name	Description
DockHostController	dhc	The DockHostController instance.
System.Drawing.Point	pt	The coordinate point.

ShowMenu(DockHostController, Point, Boolean)

Declaration

protected void ShowMenu(DockHostController dhc, Point pt, bool singleTabOperate)

Parameters

Type	Name	Description
DockHostController	dhc
System.Drawing.Point	pt
System.Boolean	singleTabOperate

ShowMenu(Control, Point)

Shows the Docking caption context menu at the specified point.

Declaration

public void ShowMenu(Control ctrl, Point pt)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	Instance of a control
System.Drawing.Point	pt	The location of the menu to be displayed.

StopAutoHideAnimation()

Declaration

protected void StopAutoHideAnimation()

subclass_OnDeactivate(Object, Message)

Declaration

protected void subclass_OnDeactivate(object sender, Message m)

Parameters

Type	Name	Description
System.Object	sender
System.Windows.Forms.Message	m

SuspendHooks()

Suspends listening to system wide hooks.

Declaration

public void SuspendHooks()

SuspendLayout()

Call this so that the DockingManager will not attempt to layout the elements on the form when another action is taking place (like merging MDI children into the menus)

Declaration

public void SuspendLayout()

ToggleAHState(DockHostController, Boolean, Boolean, Boolean)

Toggles autohide state for specified DockHostController.

Declaration

protected void ToggleAHState(DockHostController dhc, bool ahState, bool singleTab, bool animate)

Parameters

Type	Name	Description
DockHostController	dhc	DockHostController to toggle state for.
System.Boolean	ahState	If true - enter AH state, else exit AH state
System.Boolean	singleTab	IF parent is DockTabControl specifies if to toggle AH state for single dhc or for entire DockTabControl.
System.Boolean	animate	If to animate autohiding.

ToggleAHState(Control, Boolean, Boolean, Boolean)

Toggles autohide state for specified Control.

Declaration

protected void ToggleAHState(Control ctrl, bool ahState, bool singleTab, bool animate)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl
System.Boolean	ahState	If true - enter AH state, else exit AH state
System.Boolean	singleTab	IF parent is TabControl specifies if to toggle AH state for single Control or for entire TabControl.
System.Boolean	animate	If to animate autohiding.

UndockFromController(DockControllerBase)

Declaration

protected void UndockFromController(DockControllerBase ctrl)

Parameters

Type	Name	Description
DockControllerBase	ctrl

UnlockDockPanelsUpdate()

Unlocks panel repainting.

Declaration

public void UnlockDockPanelsUpdate()

UnlockHostFormUpdate()

Unlocks host form's updates.

Declaration

public void UnlockHostFormUpdate()

UpdateFloatingFormsImages()

Declaration

protected void UpdateFloatingFormsImages()

Events

AutoHideAnimationStart

Occurs just before the start of autohide animation.

Declaration

public event AutoHideAnimationEventHandler AutoHideAnimationStart

Event Type

Type	Description
AutoHideAnimationEventHandler

Examples

This example describes how to prevent the animation when we hide controls

private void dockingManager1_AutoHideAnimationStart(object sender, Syncfusion.Windows.Forms.Tools.AutoHideAnimationEventArgs arg)
{
   if (arg.DockBorder == DockStyle.Left || arg.DockBorder == DockStyle.Right)
       Syncfusion.Windows.Forms.Tools.DockingManager.AnimationStep = arg.Bounds.Width;
   else
       Syncfusion.Windows.Forms.Tools.DockingManager.AnimationStep = arg.Bounds.Height;
}

Private Sub DockingManager1_AutoHideAnimationStart(ByVal sender As System.Object, ByVal arg As Syncfusion.Windows.Forms.Tools.AutoHideAnimationEventArgs) Handles DockingManager1.AutoHideAnimationStart
    If (arg.DockBorder = DockStyle.Left Or arg.DockBorder = DockStyle.Right) Then
        Syncfusion.Windows.Forms.Tools.DockingManager.AnimationStep = arg.Bounds.Width
    Else
        Syncfusion.Windows.Forms.Tools.DockingManager.AnimationStep = arg.Bounds.Height
    End If
End Sub

AutoHideAnimationStop

Occurs immediately after the end of autohide animation.

Declaration

public event AutoHideAnimationEventHandler AutoHideAnimationStop

Event Type

Type	Description
AutoHideAnimationEventHandler

AutoHideTabContextMenu

Occurs when the right mouse button is clicked over a AutoHideTabControl.

Declaration

public event AutoHideTabContextMenuEventHandler AutoHideTabContextMenu

Event Type

Type	Description
AutoHideTabContextMenuEventHandler

ControlMaximized

Occurs after control is maximized.

Declaration

public event ControlMaximizedEventHandler ControlMaximized

Event Type

Type	Description
ControlMaximizedEventHandler

ControlMaximizing

Occurs before control is going to maximize.

Declaration

public event ControlMaximizeEventHandler ControlMaximizing

Event Type

Type	Description
ControlMaximizeEventHandler

ControlMinimized

Occurs after control is minimized.

Declaration

public event ControlMinimizeEventHandler ControlMinimized

Event Type

Type	Description
ControlMinimizeEventHandler

ControlRestored

Occurs after control is restored.

Declaration

public event ControlRestoreEventHandler ControlRestored

Event Type

Type	Description
ControlRestoreEventHandler

DockAllow

Declaration

public event DockAllowEventHandler DockAllow

Event Type

Type	Description
DockAllowEventHandler

DockContextMenu

Occurs when the right mouse button is clicked over a docking window's caption.

Declaration

public event DockContextMenuEventHandler DockContextMenu

Event Type

Type	Description
DockContextMenuEventHandler

Examples

This example demonstrates how to remove menu for a particular control

private void docMgr_DockContextMenu(object sender, Syncfusion.Windows.Forms.Tools.DockContextMenuEventArgs arg){
//Checking the control and assigning an empty menu
if (arg.Owner == panel1)
      arg.ContextMenu = new Syncfusion.Windows.Forms.Tools.XPMenus.PopupMenu();
}

 Private Sub dockingManager1_DockContextMenu(ByVal sender As Object, ByVal arg As Syncfusion.Windows.Forms.Tools.DockContextMenuEventArgs) Handles dockingManager1.DockContextMenu
 'Checking the control and assigning an empty menu
 If (arg.Owner == panel1) Then
      arg.ContextMenu = new Syncfusion.Windows.Forms.Tools.XPMenus.PopupMenu()
 End If
 End Sub

DockControlActivated

Occurs when a dockable control gets activated.

Declaration

public event DockActivationChangedEventHandler DockControlActivated

Event Type

Type	Description
DockActivationChangedEventHandler

DockControlActivating

Occurs before the dock control is activated.

Declaration

public event EventHandler<DockControlActivatingEventArgs> DockControlActivating

Event Type

Type	Description
System.EventHandler<DockControlActivatingEventArgs>

DockControlDeactivated

Occurs when a dockable control gets deactivated.

Declaration

public event DockActivationChangedEventHandler DockControlDeactivated

Event Type

Type	Description
DockActivationChangedEventHandler

DockMenuClick

Occurs when the redock context menu item has been clicked.

Declaration

public event DockMenuClickEventHandler DockMenuClick

Event Type

Type	Description
DockMenuClickEventHandler

DockStateChanged

Occurs immediately after a dock operation.

Declaration

public event DockStateChangeEventHandler DockStateChanged

Event Type

Type	Description
DockStateChangeEventHandler

DockStateChanging

Occurs just before a dock operation takes place.

Declaration

public event DockStateChangeEventHandler DockStateChanging

Event Type

Type	Description
DockStateChangeEventHandler

DockStateUnavailable

Occurs if serialized information is not available for a dockable control when loading a persisted dock state.

Declaration

public event DockStateUnavailableEventHandler DockStateUnavailable

Event Type

Type	Description
DockStateUnavailableEventHandler

Remarks

The DockingManager fires this event when it cannot find any persistence information for a dockable control when loading a saved dock state. The particular control's DockVisibility property will be set to FALSE and the control hidden.

DockVisibilityChanged

Occurs after a control's DockVisibility state has changed.

Declaration

public event DockVisibilityChangedEventHandler DockVisibilityChanged

Event Type

Type	Description
DockVisibilityChangedEventHandler

DockVisibilityChanging

Occurs when a control's DockVisibility state is changing.

Declaration

public event DockVisibilityChangingEventHandler DockVisibilityChanging

Event Type

Type	Description
DockVisibilityChangingEventHandler

Examples

This example demonstrates how to cancel closing of a docked control

 private void dockingManager1_DockVisibilityChanging(object sender, Syncfusion.Windows.Forms.Tools.DockVisibilityChangingEventArgs arg){
 //Check the control and cancel closing.
    if (arg.Control == panel1)
            arg.Cancel = true;
}

 Private Sub dockingManager1_DockVisibilityChanging(ByVal sender As Object, ByVal arg As Syncfusion.Windows.Forms.Tools.DockContextMenuEventArgs) Handles dockingManager1.DockVisibilityChanging
'Check the control and cancel closing.
if (arg.Control == Panel1) Then
       arg.Cancel = true;
End If
End Sub

DragAllow

Occurs when a docking window is about to be dragged.

Declaration

public event DragAllowEventHandler DragAllow

Event Type

Type	Description
DragAllowEventHandler

Remarks

The DragAllow event is used by the DockingManager to provide information about an upcoming drag operation. The drag can be cancelled by setting the event argument's Cancel property.

Examples

This example shows how to cancel dragging on a particular control

 private void dockingManager1_DragAllow(object sender, Syncfusion.Windows.Forms.Tools.DragAllowEventArgs arg){
//Check the control which is going to be dragged and cancel according to that 
if(arg.Control==panel1)
arg.Cancel=true;
}

Private Sub dockingManager1_DragAllow(ByVal sender As Object, ByVal arg As Syncfusion.Windows.Forms.Tools.DragAllowEventArgs) Handles dockingManager1.DragAllow
'Check the control which is going to be dragged and cancel according to that 
    If(arg.Control==panel1)Then
        arg.Cancel=true;
    EndIf
End Sub

DragFeedbackStart

Occurs just before the start of feedback of a drag operation.

Declaration

public event EventHandler DragFeedbackStart

Event Type

Type	Description
System.EventHandler

DragFeedbackStop

Occurs immediately after the end of feedback of a drag operation.

Declaration

public event EventHandler DragFeedbackStop

Event Type

Type	Description
System.EventHandler

ImageListChanged

Occurs when the ImageList property changes.

Declaration

public event EventHandler ImageListChanged

Event Type

Type	Description
System.EventHandler

Remarks

The ImageListChanged event occurs when a new imagelist is assigned to the DockingManager.

InitializeControlOnLoad

Occurs when the DockingManager is not able to locate a control during a LoadDockState() call.

Declaration

public event InitializeControlOnLoadEventHandler InitializeControlOnLoad

Event Type

Type	Description
InitializeControlOnLoadEventHandler

Remarks

The DockingManager fires this event when it is unable to find a previously persisted control during a LoadDockState() operation. Applications can use this event as a hint to create and initialize controls selectively based on the control set present in the previously persisted docking layout.

NewDockStateBeginLoad

Occurs just before a new dock state is loaded.

Declaration

public event EventHandler NewDockStateBeginLoad

Event Type

Type	Description
System.EventHandler

NewDockStateEndLoad

Occurs immediately after a new dock state has been loaded.

Declaration

public event EventHandler NewDockStateEndLoad

Event Type

Type	Description
System.EventHandler

Remarks

We can get the result of dock state loading operation if we cast the event handler argument to the DockStateLoadEventArgs

Examples

private void dockingManager1_NewDockStateEndLoad(object sender, EventArgs e)
{
    DockStateLoadEventArgs dsle = (DockStateLoadEventArgs)e;
    Console.WriteLine(dsle.LoadResult.ToString());
}

Private Sub DockingManager_NewDockStateEndLoad(ByVal sender As Object, ByVal e As System.EventArgs) Handles DockingManager.NewDockStateEndLoad
    Dim dsle As DockStateLoadEventArgs = CType(e, DockStateLoadEventArgs)
    Console.WriteLine(dsle.LoadResult)
End Sub

OnCaptionDoubleClick

Enable user to detect once double click occurs on docked windows caption

Declaration

public event DockMouseSelectionEventHandler OnCaptionDoubleClick

Event Type

Type	Description
DockMouseSelectionEventHandler

PreviewDockHints

Occurs before displaying the dock hints when drag the windows in DockingManager.

Declaration

public event EventHandler<PreviewDockHintsEventArgs> PreviewDockHints

Event Type

Type	Description
System.EventHandler<PreviewDockHintsEventArgs>

ProvideGraphicsItems

Occurs whenever a dockable control's caption needs to be painted.

Declaration

public event ProvideGraphicsItemsEventHandler ProvideGraphicsItems

Event Type

Type	Description
ProvideGraphicsItemsEventHandler

Examples

This sample illustrates how to use this event to custom paint title bar of a docked control

void dockingManager1_ProvideGraphicsItems(object sender, Syncfusion.Windows.Forms.Tools.ProvideGraphicsItemsEventArgs arg)
{
  if (arg.Control == panel1) //Checks if the control is panel1
  {
    if (arg.IsActiveCaption)//Different drawing for active and inactive states
    {
       arg.CaptionBackground = Brushes.Blue;
       arg.CaptionFont = new Font("Times New Roman", 10);
       arg.CaptionForeground = Color.White;
    }
    else{
       arg.CaptionBackground = Brushes.Gray;
       arg.CaptionFont = new Font("Times New Roman", 10);
       arg.CaptionForeground = Color.White;
    }
  }
}

Private Sub DockingManager1_ProvideGraphicsItems(ByVal sender As System.Object, ByVal arg As Syncfusion.Windows.Forms.Tools.ProvideGraphicsItemsEventArgs) Handles DockingManager1.ProvideGraphicsItems
If arg.Control Is Panel1 Then ' Checks if the control is panel1
    If arg.IsActiveCaption then 'Different drawing for active and inactive states
        arg.CaptionBackground = Brushes.Blue
        arg.CaptionFont = New Font("Times New Roman", 10)
        arg.CaptionForeground = Color.White
    Else
        arg.CaptionBackground = Brushes.Gray
        arg.CaptionFont = New Font("Times New Roman", 10)
        arg.CaptionForeground = Color.White
    End If
End If
End Sub

ProvidePersistenceID

Lets you specify a unique ID used to distinguish the persistence information of different instances of the Form type.

Declaration

public event ProvidePersistenceIDEventHandler ProvidePersistenceID

Event Type

Type	Description
ProvidePersistenceIDEventHandler

Remarks

The default persistence logic assumes that applications will have only unique instances of top-level Forms. In applications that deviate from this normal and have multiple instances of the same top-level form, the persisted state of one form will be overridden by another as the default logic makes no attempt to distinguish between the multiples. The ProvidePersistenceID event allows users' to workaround this particular condition, by permitting unique identifiers to be assigned for each instance of the form.

TabGroupCreated

Occurs after creating new document tab group. It provides the tab group details.

Declaration

public event TabGroupCreatedEventHandler TabGroupCreated

Event Type

Type	Description
TabGroupCreatedEventHandler

TabGroupCreating

Occurs before creating a new document tab group. It can be handled to cancel tab group creation.

Declaration

public event TabGroupCreatingEventHandler TabGroupCreating

Event Type

Type	Description
TabGroupCreatingEventHandler

Examples

This example demonstrates how to cancel creating document tab group

  private void DockingManager1_TabGroupCreating(object sender, Syncfusion.Windows.Forms.Tools.TabGroupCreatingEventArgs arg){
 //Check the TargetItem and cancel creating document tab group.
    if (arg.TargetItem == panel1)
            arg.Cancel = true;
  //Check the Orientation and cancel creating document tab group.
    if (arg.Orientation== Orientation.Horizontal)
            arg.Cancel = true;
}

 Private Sub DockingManager1_TabGroupCreating(ByVal sender As Object, ByVal arg As Syncfusion.Windows.Forms.Tools.TabGroupCreatingEventArgs) Handles dockingManager1.DockVisibilityChanging
'Check the control and cancel creating document tab group
if (arg.TargetItem == Panel1) Then
       arg.Cancel = true
 'Check the Orientation and cancel creating document tab group.
if (arg.Orientation== Orientation.Horizontal) Then
       arg.Cancel = true
End If
End Sub

TransferredToManager

Occurs after a dockable control that previously belonged to some other DockingManager has been transferred to the docking layout hosted by this DockingManager.

Declaration

public event TransferManagerEventHandler TransferredToManager

Event Type

Type	Description
TransferManagerEventHandler

Remarks

TransferringFromManager AddToTargetManagersList(DockingManager) RemoveFromTargetManagersList(DockingManager)

TransferringFromManager

Occurs when a dockable control hosted by this DockingManager is about to be transferred to the docking layout hosted by some other DockingManager.

Declaration

public event TransferManagerEventHandler TransferringFromManager

Event Type

Type	Description
TransferManagerEventHandler

Remarks

TransferredToManager AddToTargetManagersList(DockingManager) RemoveFromTargetManagersList(DockingManager)

WindowAutoHiding

Event occurs before control AutoHide, when mouse pointer leave its bounds. The event will raised when AutoHideSelectionStyle is specified as MouseHover.

Declaration

public event WindowAutoHidingEventHandler WindowAutoHiding

Event Type

Type	Description
WindowAutoHidingEventHandler

Explicit Interface Implementations

IVisualStyle.VisualTheme

Gets or sets the VisualTheme.

Declaration

string IVisualStyle.VisualTheme { get; set; }

Returns

Type	Description
System.String

IDockingManagerDesignerInvoke.ApplyDHCFloatOnlySettings()

Declaration

void IDockingManagerDesignerInvoke.ApplyDHCFloatOnlySettings()

IDockingManagerDesignerInvoke.GetControllerList()

Declaration

ArrayList IDockingManagerDesignerInvoke.GetControllerList()

Returns

Type	Description
System.Collections.ArrayList

IDockingManagerDesignerInvoke.GetDHCInFocus()

Declaration

DockHostController IDockingManagerDesignerInvoke.GetDHCInFocus()

Returns

Type	Description
DockHostController

IDockingManagerDesignerInvoke.GetDockAbilityTable()

Declaration

Hashtable IDockingManagerDesignerInvoke.GetDockAbilityTable()

Returns

Type	Description
System.Collections.Hashtable

IDockingManagerDesignerInvoke.GetEnableDockingList()

Declaration

ArrayList IDockingManagerDesignerInvoke.GetEnableDockingList()

Returns

Type	Description
System.Collections.ArrayList

IDockingManagerDesignerInvoke.GetFFControllerList()

Declaration

ArrayList IDockingManagerDesignerInvoke.GetFFControllerList()

Returns

Type	Description
System.Collections.ArrayList

IDockingManagerDesignerInvoke.GetFreezeResizeControllers()

Declaration

ArrayList IDockingManagerDesignerInvoke.GetFreezeResizeControllers()

Returns

Type	Description
System.Collections.ArrayList

IDockingManagerDesignerInvoke.GetHostFormController()

Declaration

MainFormController IDockingManagerDesignerInvoke.GetHostFormController()

Returns

Type	Description
MainFormController

IDockingManagerDesignerInvoke.GetIconTable()

Declaration

Hashtable IDockingManagerDesignerInvoke.GetIconTable()

Returns

Type	Description
System.Collections.Hashtable

IDockingManagerDesignerInvoke.GetInheritedControlsList()

Declaration

ArrayList IDockingManagerDesignerInvoke.GetInheritedControlsList()

Returns

Type	Description
System.Collections.ArrayList

IDockingManagerDesignerInvoke.GetmIconTable()

Declaration

Hashtable IDockingManagerDesignerInvoke.GetmIconTable()

Returns

Type	Description
System.Collections.Hashtable

IDockingManagerDesignerInvoke.GetOuterDockAbilityTable()

Declaration

Hashtable IDockingManagerDesignerInvoke.GetOuterDockAbilityTable()

Returns

Type	Description
System.Collections.Hashtable

IDockingManagerDesignerInvoke.GetPrimarySelection()

Declaration

object IDockingManagerDesignerInvoke.GetPrimarySelection()

Returns

Type	Description
System.Object

IDockingManagerDesignerInvoke.GetTextTable()

Declaration

Hashtable IDockingManagerDesignerInvoke.GetTextTable()

Returns

Type	Description
System.Collections.Hashtable

IDockingManagerDesignerInvoke.LoadFromStream(Stream)

Declaration

bool IDockingManagerDesignerInvoke.LoadFromStream(Stream file)

Parameters

Type	Name	Description
System.IO.Stream	file

Returns

Type	Description
System.Boolean

IDockingManagerDesignerInvoke.SetDHCInFocus(DockHostController)

Declaration

void IDockingManagerDesignerInvoke.SetDHCInFocus(DockHostController dhc)

Parameters

Type	Name	Description
DockHostController	dhc

IDockingManagerDesignerInvoke.SetSelectedComponents(ICollection, SelectionTypes)

Declaration

void IDockingManagerDesignerInvoke.SetSelectedComponents(ICollection clln, SelectionTypes seltype)

Parameters

Type	Name	Description
System.Collections.ICollection	clln
System.ComponentModel.Design.SelectionTypes	seltype

Implements

System.IDisposable

IThemeProvider

IVisualStyle

System.ComponentModel.IExtenderProvider

System.ComponentModel.ISupportInitialize

IDockingManagerDesignerInvoke

ICallWndProcListener

WinForms- v20.1.0.55

Class DockingManager

Inheritance

Implements

Inherited Members

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

Remarks

Examples

Constructors

DockingManager()

Declaration

DockingManager(IContainer)

Declaration

Parameters

Fields

ahTabAnimate

Declaration

Field Value

alDockAreaControllers

Declaration

Field Value

alEnableDocking

Declaration

Field Value

alFFControllers

Declaration

Field Value

alInheritedControls

Declaration

Field Value

alTargetManagers

Declaration

Field Value

AnimationSpeed

Declaration

Field Value

AnimationStep

Declaration

Field Value

Examples

autoHideSelection

Declaration

Field Value

autoHideTabInView

Declaration

Field Value

bAllowActivationEvents

Declaration

Field Value

bAllowTabsMoving

Declaration

Field Value

bApplyMinMaxExtents

Declaration

Field Value

BARITEM_IMAGES_PATH

Declaration

Field Value

bAutoHideActiveControl

Declaration

Field Value

bAutoHideEnabled

Declaration

Field Value

bCancelVisibilityChangingEvent

Declaration

Field Value

bCloseEnabled

Declaration

Field Value

bControlScopeImages

Declaration

Field Value

bDesignProcess

Declaration

Field Value

bDisallowFloating

Declaration