WinForms

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

    Show / Hide Table of Contents

    Class DockTabController

    The DockTab controlller class provide the abiltiy to tab the docked control.

    Inheritance
    System.Object
    DockControllerBase
    DockStateControllerBase
    DockTabController
    Implements
    System.IDisposable
    Inherited Members
    DockStateControllerBase.dockInfoNew
    DockStateControllerBase.dockInfoPrevious
    DockStateControllerBase.m_form
    DockStateControllerBase.m_prevWrapper
    DockStateControllerBase.m_sharedForm
    DockStateControllerBase.m_tempWrapper
    DockStateControllerBase.m_prevFloatSize
    DockStateControllerBase.m_prevDockSize
    DockStateControllerBase.m_prevFloatLocation
    DockStateControllerBase.m_prevAHStyle
    DockStateControllerBase.bFreezeResize
    DockStateControllerBase.m_storedDockSizes
    DockStateControllerBase.m_storedFloatSizes
    DockStateControllerBase.m_releasedWrapper
    DockStateControllerBase.bInAutoHide
    DockStateControllerBase.bAutoHideSizing
    DockStateControllerBase.m_storedSizes
    DockStateControllerBase.m_siblingMinimization
    DockStateControllerBase.PerformSizeCorrection(SizingController)
    DockStateControllerBase.PerformSizeCorrection(SizingController, DockPreference)
    DockStateControllerBase.TransientControllerChanged(Object, ControllerChangedEventArgs)
    DockStateControllerBase.GetTopSizingController(SizingController)
    DockStateControllerBase.CanMaximize
    DockStateControllerBase.DockEdge
    DockStateControllerBase.AutoHideIndex
    DockStateControllerBase.PreviousAutoHideIndex
    DockStateControllerBase.DINew
    DockStateControllerBase.DIPrevious
    DockStateControllerBase.AutoHideMode
    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.IsTargetController(Point)
    DockControllerBase.IsTargetController(Control)
    DockControllerBase.AddChild(DockControllerBase, DockingStyle)
    DockControllerBase.InsertChild(DockControllerBase, Int32, DockingStyle)
    DockControllerBase.ReplaceChild(DockControllerBase, DockControllerBase)
    DockControllerBase.FireControllerChanged(DockInfo, DCRelationship)
    DockControllerBase.IterChildControllers(DockControllerBase, DCRelationship)
    DockControllerBase.ComputeLRTBBorders(Rectangle, Int32, Rectangle[])
    DockControllerBase.OnControllerChanged(ControllerChangedEventArgs)
    DockControllerBase.Dispose()
    DockControllerBase.MoveController()
    DockControllerBase.DockingManager
    DockControllerBase.Deleting
    DockControllerBase.ToplevelController
    DockControllerBase.DICurrent
    DockControllerBase.DITransient
    DockControllerBase.DockBoundary
    DockControllerBase.MainFormController
    DockControllerBase.ChildHostCount
    DockControllerBase.ChildEnumerator
    DockControllerBase.ChildHostEnumerator
    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 DockTabController : DockStateControllerBase, IDisposable, IResizable

    Constructors

    DockTabController(DockingManager, DockTabControl)

    Constructor of the DockTabController

    Declaration
    public DockTabController(DockingManager dmgr, DockTabControl tabctrl)
    Parameters
    Type Name Description
    DockingManager dmgr

    The DockingManager instance.

    DockTabControl tabctrl

    The DockTabControl instance.

    Fields

    bAllowDrag

    Declaration
    protected bool bAllowDrag
    Field Value
    Type Description
    System.Boolean

    bPause

    Declaration
    protected bool bPause
    Field Value
    Type Description
    System.Boolean

    ctrlDockTab

    Declaration
    protected DockTabControl ctrlDockTab
    Field Value
    Type Description
    DockTabControl

    currentRelationship

    Declaration
    protected DCRelationship currentRelationship
    Field Value
    Type Description
    DCRelationship

    dcHostController

    Declaration
    protected DockHostController dcHostController
    Field Value
    Type Description
    DockHostController

    dragTabPage

    Declaration
    protected DockTabPage dragTabPage
    Field Value
    Type Description
    DockTabPage

    m_nHitTab

    Variable indicating last hit tab button of tab control.

    Declaration
    protected int m_nHitTab
    Field Value
    Type Description
    System.Int32

    Properties

    ChildControllers

    Gets the ChildControllers

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

    ChildCount

    Gets the child count.

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

    DCR

    Gets the IEnumerator.

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

    DCRCurrent

    Gets / Sets the DCRelationship.

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

    Floating

    Gets / Sets the Floating

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

    FormOwner

    Declaration
    protected DockHostController FormOwner { get; }
    Property Value
    Type Description
    DockHostController

    HostControl

    Gets the host control.

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

    HostController

    Gets / Sets the HostController.

    Declaration
    public DockHostController HostController { get; set; }
    Property Value
    Type Description
    DockHostController

    InDrag

    Returns the Drag tab page.

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

    IsClosing

    Gets a value indicating whether the control is being disposed of.

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

    LayoutRect

    Gets/ Sets the Layout Rectangle.

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

    MinimumSize

    Gets the MinimumSize

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

    ParentController

    Gets / Sets the ParentController.

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

    PauseActivation

    Gets / Sets the Pause Activation.

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

    SelectedController

    Gets / Sets the SelectedController

    Declaration
    public DockHostController SelectedController { get; set; }
    Property Value
    Type Description
    DockHostController

    TabControl

    Gets the Dock Tabbed control

    Declaration
    public DockTabControl TabControl { get; }
    Property Value
    Type Description
    DockTabControl

    Methods

    AddToDCR(DCRelationship)

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

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

    The DCRelationship

    Overrides
    DockControllerBase.AddToDCR(DCRelationship)

    AdjustLayout()

    Adjust the layout of the DockTabControl.

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

    ApplyDockInfo()

    Apply Dockinfo.

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

    AttemptDCRDocking(DockControllerBase, IEnumerator)

    Attempt the docked control relationship docking.

    Declaration
    public override 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
    Overrides
    DockControllerBase.AttemptDCRDocking(DockControllerBase, IEnumerator)

    CalculateSize(Size, Size)

    Calculate the size

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

    The parent size

    System.Drawing.Size newParentSize

    The new parent size.

    Returns
    Type Description
    System.Drawing.Size

    CloseController()

    Close all tabpages and dispose tabcontrol.

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

    CloseController(DockHostController)

    Close the controller.

    Declaration
    public virtual void CloseController(DockHostController dcclose)
    Parameters
    Type Name Description
    DockHostController dcclose

    The DockHostController instance.

    CreateFloatingFrame(Point)

    Declaration
    protected virtual FloatingForm CreateFloatingFrame(Point ptlocation)
    Parameters
    Type Name Description
    System.Drawing.Point ptlocation
    Returns
    Type Description
    FloatingForm

    Dispose(Boolean)

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

    DockAsMDIChild()

    Dock the control as MDI Child.

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

    DockTab_SelectedIndexChanged(Object, EventArgs)

    The event raised when Dock tab selected index changed.

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

    The source of the control.

    System.EventArgs e

    The EventArgs contains the event data.

    EnterAutoHideMode()

    Enter the Dock tab control in AutoHide Mode

    Declaration
    public override void EnterAutoHideMode()
    Overrides
    DockStateControllerBase.EnterAutoHideMode()

    ExitAutoHideMode(Boolean)

    Exit the AutoHideMode

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

    Indicates whether close on exit.

    Overrides
    DockStateControllerBase.ExitAutoHideMode(Boolean)

    GetChildAt(Int32)

    Gets the Tab page at specified index.

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

    The index of the tab page.

    Returns
    Type Description
    DockControllerBase
    Overrides
    DockControllerBase.GetChildAt(Int32)

    GetChildHostIndex(DockControllerBase)

    Gets the index of the Child Host.

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

    The DockControllerBase instance.

    Returns
    Type Description
    System.Int32

    Returns the Host index.

    Overrides
    DockControllerBase.GetChildHostIndex(DockControllerBase)

    GetDockInfo(Control, Point, DockInfo)

    Gets the Dock information.

    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 co ordinate point

    DockInfo di

    The DockInfo.

    Overrides
    DockControllerBase.GetDockInfo(Control, Point, DockInfo)

    GetHostControlBounds()

    Declaration
    protected Rectangle GetHostControlBounds()
    Returns
    Type Description
    System.Drawing.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 ptclient)
    Parameters
    Type Name Description
    System.Windows.Forms.MouseButtons button
    System.Drawing.Point ptclient

    HandleMouseMoveImp(MouseButtons, Point)

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

    HandleMouseUpImp(MouseButtons, Point)

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

    HostControl_Resize(Object, EventArgs)

    Occurs when Resizing the hostcontrol.

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

    The source of the control.

    System.EventArgs e

    The EventArgs contains the event data.

    InsertIntoDCR(ArrayList, Int32, DCRelationship)

    Overrides the InsertIntoDCR. It helps to insert the docked control in specified index.

    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
    DockControllerBase.InsertIntoDCR(ArrayList, Int32, DCRelationship)

    InvokeDCRDocking(DockControllerBase, DCRelationship)

    Invoke the docked control relationship with Docking.

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

    The DockControllerBase instance.

    DCRelationship dcr

    The DCRelationship.

    Overrides
    DockControllerBase.InvokeDCRDocking(DockControllerBase, DCRelationship)

    InvokeDocking(DockControllerBase)

    Invoke Docking

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

    The DockControllerBase instance.

    Overrides
    DockControllerBase.InvokeDocking(DockControllerBase)

    InvokePrevDockFloatTransition(Boolean)

    Invoke the previous dock, float transition.

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

    Indicates whether the Show floating.

    Overrides
    DockControllerBase.InvokePrevDockFloatTransition(Boolean)

    IsHorizontallyResizable()

    Returns whether its resized horizontally.

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

    IsVerticallyResizable()

    Returns whether its resized vertically.

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

    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)

    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
    DockControllerBase.QueryDropProceedWithDock(Control, DockingStyle)

    QueryRelationship(DCRelationship)

    Returns the value of the Query dock relationship.

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

    The DCRelationship instance.

    Returns
    Type Description
    System.Boolean
    Overrides
    DockControllerBase.QueryRelationship(DCRelationship)

    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 it forced to new

    Returns
    Type Description
    DockControllerBase
    Overrides
    DockControllerBase.RedockController(DockInfo, Boolean)

    Refresh()

    Refresh the parent controller.

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

    RemoveChild(DockControllerBase)

    Remove the tab page

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

    The DockControllerBase instance.

    Overrides
    DockControllerBase.RemoveChild(DockControllerBase)

    RemoveDockHostFromTab(DockControllerBase, Boolean)

    Remove the DockHostFromTab

    Declaration
    public void RemoveDockHostFromTab(DockControllerBase dc, bool btransittoprev)
    Parameters
    Type Name Description
    DockControllerBase dc

    The DockControllerBase instance

    System.Boolean btransittoprev

    Indicates whether transit to previous state.

    RemoveFromDCR(DCRelationship)

    Overrides the RemoveFromDCR. It helps to remove the tab page.

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

    The DCRelationship.

    Overrides
    DockControllerBase.RemoveFromDCR(DCRelationship)

    SetHostCtrlForSelection()

    Set the Host control for selection.

    Declaration
    public void SetHostCtrlForSelection()

    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()

    Declaration
    protected void TransitToPrevDock()

    TransitToPrevFloat()

    Declaration
    protected void TransitToPrevFloat()

    UpdateControl()

    Update the Control.

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

    UpdateCurrentDCRelationship()

    Declaration
    protected void UpdateCurrentDCRelationship()

    UpdateDCRIndex(DCRelationship)

    Update the DCR index.

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

    The DCRelationship.

    Overrides
    DockControllerBase.UpdateDCRIndex(DCRelationship)

    UpdateTabsOrder(Int32, Int32)

    Declaration
    protected void UpdateTabsOrder(int oldIndex, int newIndex)
    Parameters
    Type Name Description
    System.Int32 oldIndex
    System.Int32 newIndex

    Implements

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