Class DockTabControl

The DockTabControl class, provides tab appearance in dock control.

Inheritance
System.Object
BaseControl
TabControlAdv
DockTabControl
Implements
System.IDisposable
System.ComponentModel.ISupportInitialize
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class DockTabControl : TabControlAdv, IThemeProvider, IVisualStyle, IDisposable, ITabControl, ISupportInitialize, ISupportOffice2007Theme, IDockingManagerDesignerMouseHook

Constructors

DockTabControl(DockingManager, DockHostController)

Constructor of the DockTabControl.

Declaration
public DockTabControl(DockingManager dmgr, DockHostController dhc)
Parameters
Type Name Description
DockingManager dmgr

The DockingManager instance.
DockHostController dhc

The DockHostController instance.

Fields

nNamingCount

Declaration
protected static int nNamingCount
Field Value
Type
System.Int32

nSwitchIndex

Declaration
protected int nSwitchIndex
Field Value
Type
System.Int32

tdTab

Declaration
protected ThemedControlDrawing tdTab
Field Value
Type
ThemedControlDrawing

Properties

ActiveTabFont

Gets / Sets the Active font.

Declaration
public override Font ActiveTabFont { get; set; }
Property Value
Type
System.Drawing.Font
Overrides

Alignment

Gets / Sets the Tab alignment.

Declaration
public override TabAlignment Alignment { get; set; }
Property Value
Type
System.Windows.Forms.TabAlignment
Overrides

Font

Gets / Sets the Font.

Declaration
public override Font Font { get; set; }
Property Value
Type
System.Drawing.Font
Overrides

Padding

Gets/Sets the padding.

Declaration
public override Point Padding { get; set; }
Property Value
Type
System.Drawing.Point
Overrides

ShowScroll

Indicates the Scroll button whether should display or not

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

ThemeDraw

Gets the tab for ThemedControlDrawing.

Declaration
public ThemedControlDrawing ThemeDraw { get; }
Property Value
Type
ThemedControlDrawing

Methods

AddTab(DockTabPage)

Add the DockTab page in Docked tab control.

Declaration
public void AddTab(DockTabPage newpage)
Parameters
Type Name Description
DockTabPage newpage

The DockTabPage instance.

CreateAccessibilityInstance()

Creates a new accessibility object in DockTabControl.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type Description
System.Windows.Forms.AccessibleObject

A new System.Windows.Forms.AccessibleObject for the DockTabControl, when AccessibilityEnabled for DockingManager is set as true
Overrides

Dispose(Boolean)

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

dockingManager_ImageListChanged(Object, EventArgs)

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

Draw3DBorder(Graphics, RectangleF)

Draws the 3D border around the tab control.

Declaration
protected override void Draw3DBorder(Graphics g, RectangleF borderBounds)
Parameters
Type Name Description
System.Drawing.Graphics g

The Graphics object into which the border is drawn.
System.Drawing.RectangleF borderBounds

The rectangular bounds within which the border is drawn.
Overrides

DrawPanelBackground(Graphics)

Draw the background of the MDI panel.

Declaration
protected override void DrawPanelBackground(Graphics g)
Parameters
Type Name Description
System.Drawing.Graphics g

Graphics used to draw the background.
Overrides

GetDesignMode()

Gets the design mode.

Declaration
public bool GetDesignMode()
Returns
Type
System.Boolean

GetTabHitIndex(Point)

Gets the index of the tab item

Declaration
public int GetTabHitIndex(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt

The mouse co ordinate point.
Returns
Type
System.Int32

HandleDoubleClick(Point)

Handle the Double click event.

Declaration
public void HandleDoubleClick(Point ptscreen)
Parameters
Type Name Description
System.Drawing.Point ptscreen

The mouse co ordinate point.

HandleMouseDown(MouseButtons, Point)

Handle the Mouse down event.

Declaration
public void HandleMouseDown(MouseButtons button, Point ptscreen)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button

The MouseButtonse
System.Drawing.Point ptscreen

The mouse co ordinate point.

HandleMouseLeave()

Handle the Double click event.

Declaration
public void HandleMouseLeave()

HandleMouseMove(MouseButtons, Point)

Handle the Mouse move event.

Declaration
public void HandleMouseMove(MouseButtons button, Point ptscreen)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button

The MouseButtonse
System.Drawing.Point ptscreen

The mouse co ordinate point.

HandleMouseUp(MouseButtons, Point)

Handle the Mouse up event.

Declaration
public void HandleMouseUp(MouseButtons button, Point ptscreen)
Parameters
Type Name Description
System.Windows.Forms.MouseButtons button

The MouseButtonse
System.Drawing.Point ptscreen

The mouse co ordinate point.

InitializeDockTabControl(DockingManager, DockHostController)

Declaration
protected virtual void InitializeDockTabControl(DockingManager dmgr, DockHostController dhc)
Parameters
Type Name Description
DockingManager dmgr
DockHostController dhc

InitiateFloatingResize(Point, Int32)

Initiate the Floating form resize.

Declaration
public void InitiateFloatingResize(Point ptscreen, int nchittest)
Parameters
Type Name Description
System.Drawing.Point ptscreen

The mouse co ordinate point.
System.Int32 nchittest

InsertTab(Int32, DockTabPage)

Insert the tab in DcokTab control.

Declaration
public void InsertTab(int nindex, DockTabPage newpage)
Parameters
Type Name Description
System.Int32 nindex

The index which needs to be insert the tabpage
DockTabPage newpage

The DockTabpage instance.

OnDragOver(DragEventArgs)

Declaration
protected override void OnDragOver(DragEventArgs drgevent)
Parameters
Type Name Description
System.Windows.Forms.DragEventArgs drgevent

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e
Overrides

OnMouseLeave(EventArgs)

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e
Overrides

OnMouseUp(MouseEventArgs)

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e
Overrides

OnPaint(PaintEventArgs)

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e
Overrides

OnSelectedIndexChanging(SelectedIndexChangingEventArgs)

Raises the event when select the document child.

Declaration
protected override void OnSelectedIndexChanging(SelectedIndexChangingEventArgs e)
Parameters
Type Name Description
SelectedIndexChangingEventArgs e

An instance that contains the event data.
Overrides

OnStyleChanged()

Declaration
protected override void OnStyleChanged()
Overrides

ReparentTabChildren()

This hostcontroller calls this method, when it's parent has changed. Reparent remaining tab dockclients to the hostcontroller's new parent

Declaration
public void ReparentTabChildren()

UpdateOffice2007Theme()

Declaration
protected void UpdateOffice2007Theme()

UpdateRenderer()

Update the Renderer.

Declaration
public void UpdateRenderer()

WndProc(ref Message)

Declaration
protected override void WndProc(ref Message msg)
Parameters
Type Name Description
System.Windows.Forms.Message msg
Overrides

Implements

System.IDisposable
System.ComponentModel.ISupportInitialize