Class DockHostController

DockHostControllers provide the visual feedback while dragging and are responsible for sizing the host controls.

Inheritance
System.Object
DockControllerBase
DockStateControllerBase
DockHostController
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class DockHostController : DockStateControllerBase, IDisposable, IResizable

Constructors

DockHostController(DockingManager, DockHost)

Constructor of the DockHostController

Declaration
public DockHostController(DockingManager dmgr, DockHost host)
Parameters
Type Name Description
DockingManager dmgr

The DockingManager instance.
DockHost host

The DockHost instance.

Fields

alDockDCR

Declaration
protected ArrayList alDockDCR
Field Value
Type Description
System.Collections.ArrayList

alFloatDCR

Declaration
protected ArrayList alFloatDCR
Field Value
Type Description
System.Collections.ArrayList

bAHVisible

Declaration
protected bool bAHVisible
Field Value
Type Description
System.Boolean

bCloseVisible

Declaration
protected bool bCloseVisible
Field Value
Type Description
System.Boolean

bClosing

Declaration
protected bool bClosing
Field Value
Type Description
System.Boolean

bDockVisible

Declaration
protected bool bDockVisible
Field Value
Type Description
System.Boolean

bFloating

Declaration
protected bool bFloating
Field Value
Type Description
System.Boolean

bFloatingAutoHide

Declaration
protected bool bFloatingAutoHide
Field Value
Type Description
System.Boolean

bFloatingWindowTargetSize

Declaration
protected Size bFloatingWindowTargetSize
Field Value
Type Description
System.Drawing.Size

bFloatOnly

Declaration
protected bool bFloatOnly
Field Value
Type Description
System.Boolean

bHideCaption

Declaration
protected bool bHideCaption
Field Value
Type Description
System.Boolean

bInMDIMode

Declaration
public bool bInMDIMode
Field Value
Type Description
System.Boolean

bMaxVisible

Declaration
protected bool bMaxVisible
Field Value
Type Description
System.Boolean

bMenuBtnVisible

Declaration
protected bool bMenuBtnVisible
Field Value
Type Description
System.Boolean

ctrlDockTab

Declaration
protected DockTabControl ctrlDockTab
Field Value
Type Description
DockTabControl

ctrlHost

Declaration
protected DockHost ctrlHost
Field Value
Type Description
DockHost

ctrlReference

Declaration
public Control ctrlReference
Field Value
Type Description
System.Windows.Forms.Control

m_autoHiddedBeforeHide

Declaration
protected bool m_autoHiddedBeforeHide
Field Value
Type Description
System.Boolean

m_mdiChildBounds

Declaration
protected Rectangle m_mdiChildBounds
Field Value
Type Description
System.Drawing.Rectangle

m_storedSize

Declaration
protected Size m_storedSize
Field Value
Type Description
System.Drawing.Size

nMinControlHeight

Declaration
protected const int nMinControlHeight = 45
Field Value
Type Description
System.Int32

nMinControlWidth

Declaration
protected const int nMinControlWidth = 25
Field Value
Type Description
System.Int32

siblingDCR

Declaration
protected ArrayList siblingDCR
Field Value
Type Description
System.Collections.ArrayList

tempForm

Declaration
protected FloatingForm tempForm
Field Value
Type Description
FloatingForm

Properties

AutoHideButtonVisibility

Gets / Sets the Auto Hide Visibility

Declaration
public bool AutoHideButtonVisibility { get; set; }
Property Value
Type Description
System.Boolean

AutoHideMode

Gets / Sets the Auto Hide Mode

Declaration
public override bool AutoHideMode { get; set; }
Property Value
Type Description
System.Boolean
Overrides

ChildCount

Gets the child count.

Declaration
public override int ChildCount { get; }
Property Value
Type Description
System.Int32
Overrides

ChildHostCount

Gets the child host count.

Declaration
public override int ChildHostCount { get; }
Property Value
Type Description
System.Int32
Overrides

CloseButtonVisibility

Gets / Sets the close button visibility.

Declaration
public bool CloseButtonVisibility { get; set; }
Property Value
Type Description
System.Boolean

Closing

Gets/sets if control is closing.

Declaration
protected bool Closing { get; set; }
Property Value
Type Description
System.Boolean

ControlImage

Gets / sets the control image for the controller.

Declaration
public Icon ControlImage { get; set; }
Property Value
Type Description
System.Drawing.Icon

ControlLocation

Gets / sets the Control's location in undocked mode.

Declaration
protected Point ControlLocation { get; set; }
Property Value
Type Description
System.Drawing.Point

ControlSize

Gets / sets the Control's size in undocked mode.

Declaration
protected Size ControlSize { get; set; }
Property Value
Type Description
System.Drawing.Size

DCR

Gets the IEnumerator

Declaration
public override IEnumerator DCR { get; }
Property Value
Type Description
System.Collections.IEnumerator
Overrides

DCRCurrent

Gets / Sets the DCRelationship.

Declaration
public override DCRelationship DCRCurrent { get; set; }
Property Value
Type Description
DCRelationship
Overrides

DIPrevious

Gets / Sets the previous DockInfo

Declaration
public override DockInfo DIPrevious { get; set; }
Property Value
Type Description
DockInfo
Overrides

DockDCRList

Gets/ Sets the DockDCRList.

Declaration
public ArrayList DockDCRList { get; set; }
Property Value
Type Description
System.Collections.ArrayList

DockLabel

Gets / sets the dock label for the controller.

Declaration
public string DockLabel { get; set; }
Property Value
Type Description
System.String

DockTab

Gets/ Sets the Dock Tab control.

Declaration
public DockTabControl DockTab { get; set; }
Property Value
Type Description
DockTabControl

DockVisibility

Gets / sets the visibility state of the controller.

Declaration
public bool DockVisibility { get; set; }
Property Value
Type Description
System.Boolean

FloatDCRList

Gets / Sets the FloatDCRList.

Declaration
public ArrayList FloatDCRList { get; set; }
Property Value
Type Description
System.Collections.ArrayList

Floating

Gets / Sets the floating.

Declaration
public override bool Floating { get; set; }
Property Value
Type Description
System.Boolean
Overrides

FloatingAutoHide

Gets whether floating window is in auto hide mode

Declaration
public bool FloatingAutoHide { get; set; }
Property Value
Type Description
System.Boolean

FloatingWindowTargetSize

Gets / Sets the Floating window target size.

Declaration
public Size FloatingWindowTargetSize { get; set; }
Property Value
Type Description
System.Drawing.Size

FloatOnly

Gets / Sets the Float only.

Declaration
public bool FloatOnly { get; set; }
Property Value
Type Description
System.Boolean

HideCaption

Gets / Sets the Hide caption.

Declaration
public bool HideCaption { get; set; }
Property Value
Type Description
System.Boolean

HostControl

Returns the host control.

Declaration
public override Control HostControl { get; }
Property Value
Type Description
System.Windows.Forms.Control
Overrides

ImageIndex

Gets / sets the image index for the host controller.

Declaration
public int ImageIndex { get; set; }
Property Value
Type Description
System.Int32

IsSelectedTabPage

Returns the selected tab page.

Declaration
public bool IsSelectedTabPage { get; }
Property Value
Type Description
System.Boolean

IsSingleFloatControl

Declaration
protected bool IsSingleFloatControl { get; }
Property Value
Type Description
System.Boolean

LayoutRect

Gets / sets the layout rectangle for the controller.

Declaration
public override Rectangle LayoutRect { get; set; }
Property Value
Type Description
System.Drawing.Rectangle
Overrides

MaximizeButtonVisibility

Gets / Sets the MaximizeButton Visibility

Declaration
public bool MaximizeButtonVisibility { get; set; }
Property Value
Type Description
System.Boolean

MdiImageIndex

Gets/ Sets the MDI image index. Newly Added

Declaration
public int MdiImageIndex { get; set; }
Property Value
Type Description
System.Int32

MenuButtonVisiblity

Gets / Sets the MenuButton visibility.

Declaration
public bool MenuButtonVisiblity { get; set; }
Property Value
Type Description
System.Boolean

MinimumSize

Gets/ Sets the Minimum size.

Declaration
public override Size MinimumSize { get; set; }
Property Value
Type Description
System.Drawing.Size
Overrides

ParentController

Gets or sets the ParentController.

Declaration
public override DockControllerBase ParentController { get; set; }
Property Value
Type Description
DockControllerBase
Overrides

ToolTipText

Gets / sets the ToolTip for the controller.

Declaration
public string ToolTipText { get; set; }
Property Value
Type Description
System.String

UniqueName

Gets / Sets the Unique name.

Declaration
public string UniqueName { get; set; }
Property Value
Type Description
System.String

Methods

AddChild(DockControllerBase, DockingStyle)

Overrides the AddChild.

Declaration
public override void AddChild(DockControllerBase dc, DockingStyle db)
Parameters
Type Name Description
DockControllerBase dc

The DockControllerBase instance.
DockingStyle db

The DockingStyle
Overrides

AddToDCR(DCRelationship)

Overrides the AddToDCR. It helps to add the docked control with specified dock relationship.

Declaration
public override void AddToDCR(DCRelationship dcr)
Parameters
Type Name Description
DCRelationship dcr

The DCRelationship.
Overrides

AdjustLayout()

Overrides the AdjustLayout.

Declaration
public override void AdjustLayout()
Overrides

ApplyDockInfo()

Apply dock info.

Declaration
public override void ApplyDockInfo()
Overrides

AttemptDCRDocking(DockControllerBase, IEnumerator)

Overrides the AttemptDCRDocking.

Declaration
public override bool AttemptDCRDocking(DockControllerBase ctrl, IEnumerator iedcr)
Parameters
Type Name Description
DockControllerBase ctrl
System.Collections.IEnumerator iedcr

The IEnumerator.
Returns
Type Description
System.Boolean
Overrides

CalculateSize(Size, Size)

Declaration
public Size CalculateSize(Size parentSize, Size newParentSize)
Parameters
Type Name Description
System.Drawing.Size parentSize
System.Drawing.Size newParentSize
Returns
Type Description
System.Drawing.Size

CheckSiblingRelations()

Declaration
protected void CheckSiblingRelations()

ClearParentTransientSize()

Declaration
protected void ClearParentTransientSize()

CloseController()

Undock the controller from the present dock/float state and then hide and dispose it.

Declaration
public override void CloseController()
Overrides

CreateDockTabControl()

Declaration
protected virtual DockTabControl CreateDockTabControl()
Returns
Type Description
DockTabControl

CreateFloatingFrame(Point, Boolean)

Creates the Floating form frame.

Declaration
public virtual FloatingForm CreateFloatingFrame(Point ptlocation, bool show)
Parameters
Type Name Description
System.Drawing.Point ptlocation

The location of the floating form
System.Boolean show

Indicates whether its shown or not.
Returns
Type Description
FloatingForm

dhc_ControllerChanged(Object, ControllerChangedEventArgs)

Declaration
public virtual void dhc_ControllerChanged(object sender, ControllerChangedEventArgs e)
Parameters
Type Name Description
System.Object sender
ControllerChangedEventArgs e

DHCDragSplitterMoved(Object, SplitterEventArgs)

Drag splitter moved.

Declaration
public void DHCDragSplitterMoved(object sender, SplitterEventArgs args)
Parameters
Type Name Description
System.Object sender

The source of the control.
System.Windows.Forms.SplitterEventArgs args

The SplitterEventArgs contains the event data.

Dispose(Boolean)

Declaration
protected override void Dispose(bool bdisposing)
Parameters
Type Name Description
System.Boolean bdisposing
Overrides

DockAsMDIChild()

Overrides the DockAsMDIChild. It helps to dock control as MDIChild.

Declaration
public override void DockAsMDIChild()
Overrides

EnterAutoHideMode()

Enter the Auto hide mode.

Declaration
public override void EnterAutoHideMode()
Overrides

EnterAutoHideMode(Boolean)

Declaration
protected void EnterAutoHideMode(bool animate)
Parameters
Type Name Description
System.Boolean animate

ExitAutoHideMode(Boolean)

Exit the AutoHideMode.

Declaration
public override void ExitAutoHideMode(bool bcloseonexit)
Parameters
Type Name Description
System.Boolean bcloseonexit
Overrides

ExitFloatingFrame()

Declaration
protected virtual void ExitFloatingFrame()

FindTabbedDockTarget(Boolean)

Declaration
protected DockHostController FindTabbedDockTarget(bool floating)
Parameters
Type Name Description
System.Boolean floating
Returns
Type Description
DockHostController

GetChildAt(Int32)

Gets the child at specified index.

Declaration
public override DockControllerBase GetChildAt(int index)
Parameters
Type Name Description
System.Int32 index

The index of the DockControllerBase
Returns
Type Description
DockControllerBase

Null.
Overrides

GetChildHostIndex(DockControllerBase)

Gets the index of the ChildHost index.

Declaration
public override int GetChildHostIndex(DockControllerBase child)
Parameters
Type Name Description
DockControllerBase child

The DockControllerBase instance.
Returns
Type Description
System.Int32
Overrides

GetDCRelationship(DockHostController, Int32)

Declaration
protected DCRelationship GetDCRelationship(DockHostController dhc, int nrelation)
Parameters
Type Name Description
DockHostController dhc
System.Int32 nrelation
Returns
Type Description
DCRelationship

GetDockInfo(Control, Point, DockInfo)

Get the DockInfo.

Declaration
public override void GetDockInfo(Control ctrl, Point ptscreen, DockInfo di)
Parameters
Type Name Description
System.Windows.Forms.Control ctrl

The dock enabled control.
System.Drawing.Point ptscreen

The coordinate point.
DockInfo di

The DockInfo.
Overrides

GetParentFloatingFormController()

Declaration
protected FloatingFormController GetParentFloatingFormController()
Returns
Type Description
FloatingFormController

GetSerCurrentDI()

Returns the DockInfo.

Declaration
public DockInfo GetSerCurrentDI()
Returns
Type Description
DockInfo

GetSerPreviousDI()

Returns the previous DockInfo.

Declaration
public DockInfo GetSerPreviousDI()
Returns
Type Description
DockInfo

GetTabDockTargetRectangle()

Gets the Tab Dock target rectangle.

Declaration
public Rectangle GetTabDockTargetRectangle()
Returns
Type Description
System.Drawing.Rectangle

The Rectangle

HandleDoubleClickImp(Point)

Declaration
protected void HandleDoubleClickImp(Point ptclient)
Parameters
Type Name Description
System.Drawing.Point ptclient

HandleMouseDownImp(MouseButtons, Point)

Declaration
protected void HandleMouseDownImp(MouseButtons button, Point pt)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button
System.Drawing.Point pt

HandleMouseMoveImp(MouseButtons, Point)

Declaration
protected void HandleMouseMoveImp(MouseButtons button, Point pt)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button
System.Drawing.Point pt

HandleMouseUpImp(MouseButtons, Point)

Declaration
protected void HandleMouseUpImp(MouseButtons button, Point pt)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button
System.Drawing.Point pt

InsertChild(DockControllerBase, Int32, DockingStyle)

Overrides the InsertChild.

Declaration
public override void InsertChild(DockControllerBase dc, int i, DockingStyle db)
Parameters
Type Name Description
DockControllerBase dc

The DockControllerBase instance.
System.Int32 i

The index to be inserted.
DockingStyle db

The DockingStyle
Overrides

InsertIntoDCR(ArrayList, Int32, DCRelationship)

Overrides the InsertIntoDCR. It helps to insert the docked control with specified dock relationship.

Declaration
public override void InsertIntoDCR(ArrayList al, int nindex, DCRelationship dcr)
Parameters
Type Name Description
System.Collections.ArrayList al

The ArrayList.
System.Int32 nindex

The index which needs to be inserted.
DCRelationship dcr

The DCRelationship.
Overrides

InvokeDCRDocking(DockControllerBase, DCRelationship)

Overrides the InvokeDCRDocking.

Declaration
public override void InvokeDCRDocking(DockControllerBase dc, DCRelationship dcr)
Parameters
Type Name Description
DockControllerBase dc

The DockControllerBase instance.
DCRelationship dcr

The DCRelationship.
Overrides

InvokeDocking(DockControllerBase)

Overrides the InvokeDocking.

Declaration
public override void InvokeDocking(DockControllerBase dc)
Parameters
Type Name Description
DockControllerBase dc

The DockControllerBase instance.
Overrides

InvokePrevDockFloatTransition()

Invoke the previous dock, float transition.

Declaration
public void InvokePrevDockFloatTransition()

InvokePrevDockFloatTransition(Boolean)

Overrides the InvokePrevDockFloatTransition

Declaration
public override void InvokePrevDockFloatTransition(bool showFloating)
Parameters
Type Name Description
System.Boolean showFloating

Indicates whether the show floating.
Overrides

InvokeRegularDocking(DockStateControllerBase)

Declaration
protected void InvokeRegularDocking(DockStateControllerBase ddcbase)
Parameters
Type Name Description
DockStateControllerBase ddcbase

InvokeTabbedDocking(DockStateControllerBase)

Invoke the tabbed docking.

Declaration
public void InvokeTabbedDocking(DockStateControllerBase ddcbase)
Parameters
Type Name Description
DockStateControllerBase ddcbase

The DockControllerBase instance.

IsHorizontallyResizable()

Declaration
public bool IsHorizontallyResizable()
Returns
Type Description
System.Boolean

IsVerticallyResizable()

Declaration
public bool IsVerticallyResizable()
Returns
Type Description
System.Boolean

LoadInAutoHideMode()

Load in Auto hide mode.

Declaration
public void LoadInAutoHideMode()

MoveController()

Move the controller.

Declaration
public override void MoveController()
Overrides

MoveFloatToFloat()

Move floating control to floating state.

Declaration
public void MoveFloatToFloat()

QueryController(String)

Declaration
protected override DockControllerBase QueryController(string uniqueName)
Parameters
Type Name Description
System.String uniqueName
Returns
Type Description
DockControllerBase
Overrides

QueryDropProceedWithDock(Control, DockingStyle)

Overrides the QueryDropProceedWithDock.

Declaration
public override bool QueryDropProceedWithDock(Control ctrldrop, DockingStyle style)
Parameters
Type Name Description
System.Windows.Forms.Control ctrldrop

The control which needs to be drop.
DockingStyle style

The DockingStyle.
Returns
Type Description
System.Boolean
Overrides

QueryRelationship(DCRelationship)

Overrides the QueryRelationship.

Declaration
public override bool QueryRelationship(DCRelationship dcr)
Parameters
Type Name Description
DCRelationship dcr

The DCRelationship instance.
Returns
Type Description
System.Boolean
Overrides

RedockController(DockInfo, Boolean)

Redock the controller.

Declaration
public override DockControllerBase RedockController(DockInfo di, bool bforcenew)
Parameters
Type Name Description
DockInfo di

The DockInfo
System.Boolean bforcenew

Indicates whether its force to new.
Returns
Type Description
DockControllerBase
Overrides

RemoveChild(DockControllerBase)

Overrides the RemoveChild.

Declaration
public override void RemoveChild(DockControllerBase dc)
Parameters
Type Name Description
DockControllerBase dc

The DockControllerBase instance.
Overrides

RemoveFromDCR(DCRelationship)

Overrides the RemoveFromDCR. It helps to remove the docked control.

Declaration
public override void RemoveFromDCR(DCRelationship dcr)
Parameters
Type Name Description
DCRelationship dcr

The DCRelationship.
Overrides

SelectActivationForm(ref Boolean)

Declaration
protected virtual FloatingForm SelectActivationForm(ref bool restored)
Parameters
Type Name Description
System.Boolean restored
Returns
Type Description
FloatingForm

SetPrevTabIndex(DockControllerBase, ArrayList)

Declaration
protected void SetPrevTabIndex(DockControllerBase target, ArrayList controllers)
Parameters
Type Name Description
DockControllerBase target
System.Collections.ArrayList controllers

ShowController()

Show the controller.

Declaration
public void ShowController()

ToggleAutoHideMode()

Switching to Auto Hide mode

Declaration
public void ToggleAutoHideMode()

ToggleAutoHideMode(Boolean)

Switching to the Auto hide mode

Declaration
public void ToggleAutoHideMode(bool animate)
Parameters
Type Name Description
System.Boolean animate

Indicates whether the animation is appeared or not.

TransitDockInFloatToFloat()

Transit the Docked control in Float to Floating state.

Declaration
public void TransitDockInFloatToFloat()

TransitDockToDock()

Transit the docked control to another docking state.

Declaration
public void TransitDockToDock()

TransitDockToDockInFloat()

Transit the docked control dock in Floating state.

Declaration
public void TransitDockToDockInFloat()

TransitDockToFloat()

Transit the docked control to Floating state.

Declaration
public void TransitDockToFloat()

TransitFloatToDock()

Transit the Floating control to Docked state.

Declaration
public void TransitFloatToDock()

TransitFloatToDockInFloat()

Transit the Floating to Docking in Floating state.

Declaration
public void TransitFloatToDockInFloat()

TransitToPrevDock()

Transit the control to previous Dock state.

Declaration
public void TransitToPrevDock()

TransitToPrevFloat(Boolean)

Transit the docked control to previous Float state.

Declaration
public void TransitToPrevFloat(bool showFloating)
Parameters
Type Name Description
System.Boolean showFloating

Indicates whether the Floating needs to be shown or not.

UpdateControl()

Update the docked control.

Declaration
public override void UpdateControl()
Overrides

UpdateDCRIndex(DCRelationship)

Overrides the UpdateDCRIndex.

Declaration
public override void UpdateDCRIndex(DCRelationship dcrs)
Parameters
Type Name Description
DCRelationship dcrs

The DCRelationship
Overrides

ValidateSharedForm()

Declaration
protected void ValidateSharedForm()

Implements

System.IDisposable