WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class MainFormController

    Show / Hide Table of Contents

    Class MainFormController

    The MainFormController class.

    Inheritance
    System.Object
    DockControllerBase
    MainFormController
    Implements
    System.IDisposable
    Inherited Members
    DockControllerBase.m_PreviousDockingMgr
    DockControllerBase.dockingMgr
    DockControllerBase.dcParent
    DockControllerBase.dockInfoCurrent
    DockControllerBase.nDockBoundary
    DockControllerBase.bDeleting
    DockControllerBase.m_childWrapper
    DockControllerBase.m_bMinimized
    DockControllerBase.m_bMaximized
    DockControllerBase.dockInfoTransient
    DockControllerBase.minSize
    DockControllerBase.m_bAllowFloating
    DockControllerBase.AddToDCR(DCRelationship)
    DockControllerBase.RemoveFromDCR(DCRelationship)
    DockControllerBase.InsertIntoDCR(ArrayList, Int32, DCRelationship)
    DockControllerBase.UpdateDCRIndex(DCRelationship)
    DockControllerBase.IsTargetController(Control)
    DockControllerBase.ReplaceChild(DockControllerBase, DockControllerBase)
    DockControllerBase.CloseController()
    DockControllerBase.FireControllerChanged(DockInfo, DCRelationship)
    DockControllerBase.InvokePrevDockFloatTransition(Boolean)
    DockControllerBase.RedockController(DockInfo, Boolean)
    DockControllerBase.QueryRelationship(DCRelationship)
    DockControllerBase.IterChildControllers(DockControllerBase, DCRelationship)
    DockControllerBase.ComputeLRTBBorders(Rectangle, Int32, Rectangle[])
    DockControllerBase.OnControllerChanged(ControllerChangedEventArgs)
    DockControllerBase.Dispose()
    DockControllerBase.ApplyDockInfo()
    DockControllerBase.MoveController()
    DockControllerBase.DockingManager
    DockControllerBase.Deleting
    DockControllerBase.ParentController
    DockControllerBase.ToplevelController
    DockControllerBase.DICurrent
    DockControllerBase.DITransient
    DockControllerBase.DockBoundary
    DockControllerBase.MainFormController
    DockControllerBase.DCRCurrent
    DockControllerBase.ChildHostEnumerator
    DockControllerBase.MinimumSize
    DockControllerBase.ControllerChanged
    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 MainFormController : DockControllerBase, IDisposable

    Constructors

    MainFormController(DockingManager, ContainerControl)

    Constructor of the MainFormController

    Declaration
    public MainFormController(DockingManager mgr, ContainerControl host)
    Parameters
    Type Name Description
    DockingManager mgr

    The DockingManager instance.

    System.Windows.Forms.ContainerControl host

    The ContainerControl.

    Fields

    ahTabCtrlB

    Declaration
    protected AHTabControl ahTabCtrlB
    Field Value
    Type Description
    AHTabControl

    ahTabCtrlL

    Declaration
    protected AHTabControl ahTabCtrlL
    Field Value
    Type Description
    AHTabControl

    ahTabCtrlR

    Declaration
    protected AHTabControl ahTabCtrlR
    Field Value
    Type Description
    AHTabControl

    ahTabCtrlT

    Declaration
    protected AHTabControl ahTabCtrlT
    Field Value
    Type Description
    AHTabControl

    alChildren

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

    alVisibleFloatingForms

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

    bOverlapSizing

    Declaration
    public bool bOverlapSizing
    Field Value
    Type Description
    System.Boolean

    ctrlFormClient

    Declaration
    protected Control ctrlFormClient
    Field Value
    Type Description
    System.Windows.Forms.Control

    ctrlHost

    Declaration
    protected ContainerControl ctrlHost
    Field Value
    Type Description
    System.Windows.Forms.ContainerControl

    dcPriority

    Declaration
    protected DockControllerBase dcPriority
    Field Value
    Type Description
    DockControllerBase

    fhCtrl

    Declaration
    protected FocusHolder fhCtrl
    Field Value
    Type Description
    FocusHolder

    frmTopLevelSubscribed

    Declaration
    protected Form frmTopLevelSubscribed
    Field Value
    Type Description
    System.Windows.Forms.Form

    m_bInLayout

    Declaration
    protected bool m_bInLayout
    Field Value
    Type Description
    System.Boolean

    rcClientPool

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

    rcLayout

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

    Properties

    ChildControllers

    Gets the ChildControllers.

    Declaration
    public override ArrayList ChildControllers { get; }
    Property Value
    Type Description
    System.Collections.ArrayList
    Overrides
    DockControllerBase.ChildControllers

    ChildCount

    Gets the ChildCount

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

    ChildEnumerator

    Gets the ChildEnumerator

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

    ChildHostCount

    Gets the ChildHostCount.

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

    DCR

    Gets the IEnumerator.

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

    Floating

    Gets / Sets the Floating.

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

    FocusHolderControl

    Gets the FocusHolderControl

    Declaration
    public FocusHolder FocusHolderControl { get; }
    Property Value
    Type Description
    FocusHolder

    HostControl

    Gets the HostControl

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

    LayoutRect

    Gets / Sets the Layout Rectangle.

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

    PriorityController

    Gets / Sets the PriorityController

    Declaration
    public DockControllerBase PriorityController { get; set; }
    Property Value
    Type Description
    DockControllerBase

    Methods

    AddChild(DockControllerBase, DockingStyle)

    Add child

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

    The DockControllerBase instance.

    DockingStyle db

    The Syncfusion.Windows.Forms.Tools.DockingStyle.

    Overrides
    DockControllerBase.AddChild(DockControllerBase, DockingStyle)

    AdjustLayout()

    Adjust the layout of the Form controller.

    Declaration
    public override void AdjustLayout()
    Overrides
    DockControllerBase.AdjustLayout()

    AdjustLayoutDockArea()

    Adjust the layout dock area.

    Declaration
    public virtual void AdjustLayoutDockArea()

    AllowSplitterSizing(DockControllerBase, Int32)

    Allow the splitter sizing.

    Declaration
    public bool AllowSplitterSizing(DockControllerBase dcbase, int deltasize)
    Parameters
    Type Name Description
    DockControllerBase dcbase

    The DockStateControllerBase instance.

    System.Int32 deltasize
    Returns
    Type Description
    System.Boolean

    AttemptDCRDocking(DockControllerBase, IEnumerator)

    Overrides the AttemptDCRDocking

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

    The DockControllerBase instance.

    System.Collections.IEnumerator iedcr
    Returns
    Type Description
    System.Boolean
    Overrides
    DockControllerBase.AttemptDCRDocking(DockControllerBase, IEnumerator)

    ChildControl_DockChanged(Object, EventArgs)

    Declaration
    protected void ChildControl_DockChanged(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    ChildControl_SizeChanged(Object, EventArgs)

    Declaration
    protected void ChildControl_SizeChanged(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    ChildControl_VisibleChanged(Object, EventArgs)

    Declaration
    protected void ChildControl_VisibleChanged(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    ctrl_Disposed(Object, EventArgs)

    Declaration
    protected void ctrl_Disposed(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    Dispose(Boolean)

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

    DockAsMDIChild()

    Overrides the DockAsMDIChild.

    Declaration
    public override void DockAsMDIChild()
    Overrides
    DockControllerBase.DockAsMDIChild()

    DrawDockEdgeBorders(Graphics)

    Declaration
    protected virtual void DrawDockEdgeBorders(Graphics gph)
    Parameters
    Type Name Description
    System.Drawing.Graphics gph

    EnterAutoHideMode(DockStateControllerBase, Boolean)

    Enter on AutoHideMode

    Declaration
    public void EnterAutoHideMode(DockStateControllerBase ddcbase, bool animate)
    Parameters
    Type Name Description
    DockStateControllerBase ddcbase

    The DockStateControllerBase instance.

    System.Boolean animate

    Indicates whether it need to be animate or not.

    ExitAutoHideMode(DockStateControllerBase, Boolean)

    Exit the AutoHideMode

    Declaration
    public void ExitAutoHideMode(DockStateControllerBase ddcbase, bool bcloseonexit)
    Parameters
    Type Name Description
    DockStateControllerBase ddcbase

    The DockStateControllerBase instance.

    System.Boolean bcloseonexit

    Indicates whether its closed on exit.

    GetAHTabControl(DockingStyle)

    Gets the GetAHTabControl

    Declaration
    public AHTabControl GetAHTabControl(DockingStyle border)
    Parameters
    Type Name Description
    DockingStyle border

    The Syncfusion.Windows.Forms.Tools.DockingStyle.

    Returns
    Type Description
    AHTabControl

    GetBorderController(DockingStyle)

    Gets the BorderController

    Declaration
    public DockControllerBase GetBorderController(DockingStyle border)
    Parameters
    Type Name Description
    DockingStyle border

    The Syncfusion.Windows.Forms.Tools.DockingStyle

    Returns
    Type Description
    DockControllerBase

    GetChildAt(Int32)

    Gets the child in specified index.

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

    The index of the child.

    Returns
    Type Description
    DockControllerBase
    Overrides
    DockControllerBase.GetChildAt(Int32)

    GetChildHostIndex(DockControllerBase)

    Gets the Child host index from the child.

    Declaration
    public override int GetChildHostIndex(DockControllerBase child)
    Parameters
    Type Name Description
    DockControllerBase child
    Returns
    Type Description
    System.Int32
    Overrides
    DockControllerBase.GetChildHostIndex(DockControllerBase)

    GetControllerBorder(DockControllerBase)

    Declaration
    protected DockingStyle GetControllerBorder(DockControllerBase dctarget)
    Parameters
    Type Name Description
    DockControllerBase dctarget
    Returns
    Type Description
    DockingStyle

    GetDockInfo(Control, Point, DockInfo)

    Gets the Dock info.

    Declaration
    public override 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 mouse co ordinate point.

    DockInfo di

    The dock info.

    Overrides
    DockControllerBase.GetDockInfo(Control, Point, DockInfo)

    GetDockInfoForController(DockControllerBase)

    Gets the dock info for controller.

    Declaration
    public DockInfo GetDockInfoForController(DockControllerBase dctarget)
    Parameters
    Type Name Description
    DockControllerBase dctarget

    The DockControllerBase instance.

    Returns
    Type Description
    DockInfo

    HideAllFloatingForms()

    Declaration
    protected void HideAllFloatingForms()

    HideAllFloatingForms(Boolean)

    Declaration
    protected void HideAllFloatingForms(bool fireVisibilityChange)
    Parameters
    Type Name Description
    System.Boolean fireVisibilityChange

    HitTestBorderRect(Rectangle, ref Rectangle[], Point, DockInfo)

    Declaration
    protected virtual void HitTestBorderRect(Rectangle rcfull, ref Rectangle[] borders, Point pt, DockInfo di)
    Parameters
    Type Name Description
    System.Drawing.Rectangle rcfull
    System.Drawing.Rectangle[] borders
    System.Drawing.Point pt
    DockInfo di

    HostControl_ChildControlAdded(Object, ControlEventArgs)

    Declaration
    protected void HostControl_ChildControlAdded(object obj, ControlEventArgs e)
    Parameters
    Type Name Description
    System.Object obj
    System.Windows.Forms.ControlEventArgs e

    HostControl_ChildControlRemoved(Object, ControlEventArgs)

    Declaration
    protected void HostControl_ChildControlRemoved(object obj, ControlEventArgs e)
    Parameters
    Type Name Description
    System.Object obj
    System.Windows.Forms.ControlEventArgs e

    HostControl_Layout(Object, LayoutEventArgs)

    Declaration
    protected void HostControl_Layout(object sender, LayoutEventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Forms.LayoutEventArgs e

    HostControl_Paint(Object, PaintEventArgs)

    Declaration
    protected void HostControl_Paint(object obj, PaintEventArgs e)
    Parameters
    Type Name Description
    System.Object obj
    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_VisibleChanged(Object, EventArgs)

    Declaration
    protected void HostControl_VisibleChanged(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    InitializeComponent()

    Declaration
    protected void InitializeComponent()

    InsertChild(DockControllerBase, Int32, DockingStyle)

    Insert the child

    Declaration
    public override 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 inserted.

    DockingStyle db

    The Syncfusion.Windows.Forms.Tools.DockingStyle.

    Overrides
    DockControllerBase.InsertChild(DockControllerBase, Int32, DockingStyle)

    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
    Overrides
    DockControllerBase.InvokeDCRDocking(DockControllerBase, DCRelationship)

    InvokeDocking(DockControllerBase)

    Overrides the InvokeDocking.

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

    The DockControllerBase instance.

    Overrides
    DockControllerBase.InvokeDocking(DockControllerBase)

    IsTargetController(Point)

    Returns the TargetController

    Declaration
    public override bool IsTargetController(Point ptscreen)
    Parameters
    Type Name Description
    System.Drawing.Point ptscreen

    The mouse co ordinate point.

    Returns
    Type Description
    System.Boolean
    Overrides
    DockControllerBase.IsTargetController(Point)

    LoadInAutoHideMode(DockStateControllerBase)

    Load in AutoHideMode

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

    The DockStateControllerBase instance.

    MainForm_MdiChildActivate(Object, EventArgs)

    Declaration
    protected void MainForm_MdiChildActivate(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    OnAHSplitterPaint(Object, PaintEventArgs)

    Draw the outer border for the splitter control

    Declaration
    public void OnAHSplitterPaint(object obj, PaintEventArgs e)
    Parameters
    Type Name Description
    System.Object obj

    The source of the control.

    System.Windows.Forms.PaintEventArgs e

    The PaintEventArgs contains the event data.

    QueryController(String)

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

    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 dock enabled control

    DockingStyle style

    The Syncfusion.Windows.Forms.Tools.DockingStyle.

    Returns
    Type Description
    System.Boolean
    Overrides
    DockControllerBase.QueryDropProceedWithDock(Control, DockingStyle)

    RecGetControllerInfo(DockControllerBase, DockControllerBase)

    Declaration
    protected bool RecGetControllerInfo(DockControllerBase dc, DockControllerBase target)
    Parameters
    Type Name Description
    DockControllerBase dc
    DockControllerBase target
    Returns
    Type Description
    System.Boolean

    RecIsChildOfController(DockControllerBase, DockControllerBase)

    Declaration
    protected bool RecIsChildOfController(DockControllerBase dc, DockControllerBase target)
    Parameters
    Type Name Description
    DockControllerBase dc
    DockControllerBase target
    Returns
    Type Description
    System.Boolean

    Refresh()

    Refresh the control.

    Declaration
    public override void Refresh()
    Overrides
    DockControllerBase.Refresh()

    RemoveChild(DockControllerBase)

    Overrides the RemoveChild

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

    The DockControllerBase instance.

    Overrides
    DockControllerBase.RemoveChild(DockControllerBase)

    ShowAllFloatingForms()

    Declaration
    protected void ShowAllFloatingForms()

    ShowAllFloatingForms(Boolean)

    Declaration
    protected void ShowAllFloatingForms(bool fireVisibilityChange)
    Parameters
    Type Name Description
    System.Boolean fireVisibilityChange

    TopLevelControl_Resize(Object, EventArgs)

    Declaration
    protected void TopLevelControl_Resize(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    UpdateControl()

    Update the control.

    Declaration
    public override void UpdateControl()
    Overrides
    DockControllerBase.UpdateControl()

    UpdateFormClientSetting()

    Invoked by the docking manager when the form first loads

    Declaration
    public void UpdateFormClientSetting()

    UpdatePriorityIndices()

    Declaration
    protected void UpdatePriorityIndices()

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved