Class DockControllerBase

The DockControllerBase

Inheritance

System.Object

DockControllerBase

DockStateControllerBase

DragSplitterController

FloatingFormController

MainFormController

SizingController

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 abstract class DockControllerBase : IDisposable

Constructors

DockControllerBase(DockingManager)

Declaration

protected DockControllerBase(DockingManager mgr)

Parameters

Type	Name	Description
DockingManager	mgr

Fields

bDeleting

Declaration

protected bool bDeleting

Field Value

Type	Description
System.Boolean

dcParent

Declaration

protected DockControllerBase dcParent

Field Value

Type	Description
DockControllerBase

dockInfoCurrent

Declaration

protected DockInfo dockInfoCurrent

Field Value

Type	Description
DockInfo

dockInfoTransient

Declaration

protected DockInfo dockInfoTransient

Field Value

Type	Description
DockInfo

dockingMgr

Declaration

protected DockingManager dockingMgr

Field Value

Type	Description
DockingManager

m_bAllowFloating

Declaration

protected bool m_bAllowFloating

Field Value

Type	Description
System.Boolean

m_bMaximized

Declaration

protected bool m_bMaximized

Field Value

Type	Description
System.Boolean

m_bMinimized

Declaration

protected Minimization m_bMinimized

Field Value

Type	Description
Minimization

m_childWrapper

Declaration

protected DockControllerBase m_childWrapper

Field Value

Type	Description
DockControllerBase

m_PreviousDockingMgr

Declaration

protected DockingManager m_PreviousDockingMgr

Field Value

Type	Description
DockingManager

minSize

Declaration

protected Size minSize

Field Value

Type	Description
System.Drawing.Size

nDockBoundary

Declaration

protected int nDockBoundary

Field Value

Type	Description
System.Int32

Properties

ChildControllers

Gets the ChildControllers

Declaration

public virtual ArrayList ChildControllers { get; }

Property Value

Type	Description
System.Collections.ArrayList	Returns null.

ChildCount

Gets the Child count.

Declaration

public virtual int ChildCount { get; }

Property Value

Type	Description
System.Int32

ChildEnumerator

Gets the ChildEnumerator

Declaration

public virtual IEnumerator ChildEnumerator { get; }

Property Value

Type	Description
System.Collections.IEnumerator	Returns null.

ChildHostCount

Gets the Child Host count.

Declaration

public virtual int ChildHostCount { get; }

Property Value

Type	Description
System.Int32

ChildHostEnumerator

Gets the ChildHostEnumerator.

Declaration

public virtual IEnumerator ChildHostEnumerator { get; }

Property Value

Type	Description
System.Collections.IEnumerator	Returns null.

DCR

Gets the IEnumerator

Declaration

public virtual IEnumerator DCR { get; }

Property Value

Type	Description
System.Collections.IEnumerator	Returns null.

DCRCurrent

Gets / Sets the current DCRelationship

Declaration

public virtual DCRelationship DCRCurrent { get; set; }

Property Value

Type	Description
DCRelationship

Deleting

Gets / Sets the Deleting.

Declaration

public virtual bool Deleting { get; set; }

Property Value

Type	Description
System.Boolean

DICurrent

Gets / Sets the DICurrent.

Declaration

public virtual DockInfo DICurrent { get; set; }

Property Value

Type	Description
DockInfo

DITransient

Gets / Sets the DITransient.

Declaration

public DockInfo DITransient { get; set; }

Property Value

Type	Description
DockInfo

DockBoundary

Gets / Sets the DockBoundary.

Declaration

public int DockBoundary { get; set; }

Property Value

Type	Description
System.Int32

DockingManager

Gets / Sets the DockingManager.

Declaration

public DockingManager DockingManager { get; set; }

Property Value

Type	Description
DockingManager

Floating

Gets / Sets the floating.

Declaration

public abstract bool Floating { get; set; }

Property Value

Type	Description
System.Boolean	Returns true if the controller is hosted within a floating frame. Else false

HostControl

Gets the HostControl

Declaration

public abstract Control HostControl { get; }

Property Value

Type	Description
System.Windows.Forms.Control

LayoutRect

Gets / Sets the LayoutRect

Declaration

public abstract Rectangle LayoutRect { get; set; }

Property Value

Type	Description
System.Drawing.Rectangle

MainFormController

Gets the MainFormController

Declaration

public virtual bool MainFormController { get; }

Property Value

Type	Description
System.Boolean

MinimumSize

Gets / Sets the MinimumSize.

Declaration

public virtual Size MinimumSize { get; set; }

Property Value

Type	Description
System.Drawing.Size

ParentController

Gets / Sets the ParentController.

Declaration

public virtual DockControllerBase ParentController { get; set; }

Property Value

Type	Description
DockControllerBase

ToplevelController

Gets the ToplevelController

Declaration

public virtual DockControllerBase ToplevelController { get; }

Property Value

Type	Description
DockControllerBase

Methods

AddChild(DockControllerBase, DockingStyle)

Add the Child in DockingManager.

Declaration

public virtual void AddChild(DockControllerBase dc, DockingStyle db)

Parameters

Type	Name	Description
DockControllerBase	dc	The DockControllerBase instance.
DockingStyle	db	The DockingStyle.

AddToDCR(DCRelationship)

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

Declaration

public virtual void AddToDCR(DCRelationship dcr)

Parameters

Type	Name	Description
DCRelationship	dcr	The DCRelationship

AdjustLayout()

Adjust the layout of the docked control.

Declaration

public virtual void AdjustLayout()

ApplyDockInfo()

Apply Dock info for the docked control.

Declaration

public virtual void ApplyDockInfo()

AttemptDCRDocking(DockControllerBase, IEnumerator)

Attempt the docked control relationship docking.

Declaration

public virtual bool AttemptDCRDocking(DockControllerBase dc, IEnumerator iedcr)

Parameters

Type	Name	Description
DockControllerBase	dc	The DockControllerBase instance.
System.Collections.IEnumerator	iedcr	The IEnumerator.

Returns

Type	Description
System.Boolean

CloseController()

The Close controller.

Declaration

public virtual void CloseController()

ComputeLRTBBorders(Rectangle, Int32, ref Rectangle[])

Declaration

protected void ComputeLRTBBorders(Rectangle rcmain, int nboundary, ref Rectangle[] rc)

Parameters

Type	Name	Description
System.Drawing.Rectangle	rcmain
System.Int32	nboundary
System.Drawing.Rectangle[]	rc

Dispose()

Dispose the DockControllerBase.

Declaration

public void Dispose()

Dispose(Boolean)

Declaration

protected virtual void Dispose(bool bdispose)

Parameters

Type	Name	Description
System.Boolean	bdispose

DockAsMDIChild()

Dock as MDI child.

Declaration

public abstract void DockAsMDIChild()

Finalize()

Declaration

protected void Finalize()

FireControllerChanged(DockInfo, DCRelationship)

Occurs when controller changed.

Declaration

public void FireControllerChanged(DockInfo newdi, DCRelationship dcr)

Parameters

Type	Name	Description
DockInfo	newdi	The Dock info
DCRelationship	dcr	The DCRelationship.

GetChildAt(Int32)

Get the child at specified index.

Declaration

public virtual DockControllerBase GetChildAt(int index)

Parameters

Type	Name	Description
System.Int32	index	The index of the child.

Returns

Type	Description
DockControllerBase

GetChildHostIndex(DockControllerBase)

Get the child host index.

Declaration

public virtual int GetChildHostIndex(DockControllerBase child)

Parameters

Type	Name	Description
DockControllerBase	child	The DockControllerBase instance.

Returns

Type	Description
System.Int32

GetDockInfo(Control, Point, DockInfo)

Get the dock info of the docked control.

Declaration

public abstract void GetDockInfo(Control ctrl, Point pt, DockInfo di)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dock enabled control.
System.Drawing.Point	pt	The coordinate point that needs to get the dock information.
DockInfo	di	The DockInfo.

InsertChild(DockControllerBase, Int32, DockingStyle)

Insert the Child in DockingManager.

Declaration

public virtual void InsertChild(DockControllerBase dc, int index, DockingStyle db)

Parameters

Type	Name	Description
DockControllerBase	dc	The DockControllerBase instance.
System.Int32	index	The index which needs to be insert the child.
DockingStyle	db	The DockingStyle

InsertIntoDCR(ArrayList, Int32, DCRelationship)

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

Declaration

public virtual 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 added.
DCRelationship	dcr	The DCRelationship

InvokeDCRDocking(DockControllerBase, DCRelationship)

Invoke the docked control relationship with Docking

Declaration

public virtual void InvokeDCRDocking(DockControllerBase dc, DCRelationship dcr)

Parameters

Type	Name	Description
DockControllerBase	dc	The DockControllerBase instance.
DCRelationship	dcr	The DCRelationship.

InvokeDocking(DockControllerBase)

Invoke the Docking in DockingManager.

Declaration

public virtual void InvokeDocking(DockControllerBase dc)

Parameters

Type	Name	Description
DockControllerBase	dc	The DockControllerBase instance.

InvokePrevDockFloatTransition(Boolean)

Invoke the previous dock, float transition.

Declaration

public virtual void InvokePrevDockFloatTransition(bool showFloating)

Parameters

Type	Name	Description
System.Boolean	showFloating	Indicates whether the show floating.

IsTargetController(Point)

Validate the target controller in specified point.

Declaration

public virtual bool IsTargetController(Point ptscreen)

Parameters

Type	Name	Description
System.Drawing.Point	ptscreen	The coordinate point.

Returns

Type	Description
System.Boolean

IsTargetController(Control)

Validate the target controller in specified point.

Declaration

public virtual bool IsTargetController(Control ctrl)

Parameters

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

Returns

Type	Description
System.Boolean

IterChildControllers(DockControllerBase, DCRelationship)

Declaration

protected ControllerDCRPair IterChildControllers(DockControllerBase dc, DCRelationship dcr)

Parameters

Type	Name	Description
DockControllerBase	dc
DCRelationship	dcr

Returns

Type	Description
ControllerDCRPair

MoveController()

Move the controller.

Declaration

public virtual void MoveController()

OnControllerChanged(ControllerChangedEventArgs)

Declaration

protected virtual void OnControllerChanged(ControllerChangedEventArgs args)

Parameters

Type	Name	Description
ControllerChangedEventArgs	args

QueryController(String)

Declaration

protected virtual DockControllerBase QueryController(string uniqueName)

Parameters

Type	Name	Description
System.String	uniqueName

Returns

Type	Description
DockControllerBase

QueryDropProceedWithDock(Control, DockingStyle)

Dock the docked on dropped position.

Declaration

public virtual 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

QueryRelationship(DCRelationship)

Returns the value of the Query dock relationship.

Declaration

public virtual bool QueryRelationship(DCRelationship dcr)

Parameters

Type	Name	Description
DCRelationship	dcr	The DCRelationship instance.

Returns

Type	Description
System.Boolean

RedockController(DockInfo, Boolean)

Redock the controller.

Declaration

public virtual DockControllerBase RedockController(DockInfo di, bool bforcenew)

Parameters

Type	Name	Description
DockInfo	di	The DockInfo
System.Boolean	bforcenew	Indicates whether it forced to new

Returns

Type	Description
DockControllerBase

Refresh()

Refresh the controller.

Declaration

public virtual void Refresh()

RemoveChild(DockControllerBase)

Remove the child from DockingManager.

Declaration

public virtual void RemoveChild(DockControllerBase dc)

Parameters

Type	Name	Description
DockControllerBase	dc	The DockControllerBase.

RemoveFromDCR(DCRelationship)

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

Declaration

public virtual void RemoveFromDCR(DCRelationship dcr)

Parameters

Type	Name	Description
DCRelationship	dcr	The DCRelationship.

ReplaceChild(DockControllerBase, DockControllerBase)

Replace the child in DockingManager.

Declaration

public virtual void ReplaceChild(DockControllerBase dccurrent, DockControllerBase dcnew)

Parameters

Type	Name	Description
DockControllerBase	dccurrent	The current DockControllerBase instance.
DockControllerBase	dcnew	The new DockControllerBase instance.

UpdateControl()

Update the control.

Declaration

public abstract void UpdateControl()

UpdateDCRIndex(DCRelationship)

Update the docked control index

Declaration

public virtual void UpdateDCRIndex(DCRelationship dcrs)

Parameters

Type	Name	Description
DCRelationship	dcrs	The DCRelationship

Events

ControllerChanged

Controller Changed Event - fired whenever a target controller is changed

Declaration

public event ControllerChangedEH ControllerChanged

Event Type

Type	Description
ControllerChangedEH

Implements

System.IDisposable