Class TabHost

This class is the parent form of a tabbed MDI tab control(tab group) managed by the TabbedMDIManager.

Inheritance

System.Object

TabHost

Implements

ITabHost

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class TabHost : Form, ITabHost

Constructors

TabHost(TabbedMDIManager)

Creates a new instance of the TabHost class.

Declaration

public TabHost(TabbedMDIManager manager)

Parameters

Type	Name	Description
TabbedMDIManager	manager	The corresponding TabbedMDIManager instance.

Remarks

Meant to be used by the framework.

Properties

Alignment

Declaration

public TabAlignment Alignment { get; set; }

Property Value

Type
System.Windows.Forms.TabAlignment

BottomBorderColor

Represents TabHost's border color.

Declaration

public Color BottomBorderColor { get; set; }

Property Value

Type
System.Drawing.Color

BottomBorderHeight

Represents TabHost's border height.

Declaration

public int BottomBorderHeight { get; set; }

Property Value

Type
System.Int32

IsDockingWhidbeyStyle

Declaration

protected bool IsDockingWhidbeyStyle { get; }

Property Value

Type
System.Boolean

IsHorizontalTabGroup

Gets if TabGroup is Vertically aligned or Horizontally aligned

Declaration

public bool IsHorizontalTabGroup { get; }

Property Value

Type
System.Boolean

IsOffice2007Style

Declaration

protected bool IsOffice2007Style { get; }

Property Value

Type
System.Boolean

IsVS2008

Declaration

protected bool IsVS2008 { get; }

Property Value

Type
System.Boolean

MdiChildAutoScaleBaseDim

Returns the weight associated with this tab host when allocating the available space between tab groups.

Declaration

public int MdiChildAutoScaleBaseDim { get; }

Property Value

Type
System.Int32

MDITabPanel

Returns the MDITabPanel tab control within this form.

Declaration

public MDITabPanel MDITabPanel { get; }

Property Value

Type
MDITabPanel

Methods

AddMdiChild(Form, ITabData)

Declaration

protected virtual void AddMdiChild(Form mdiChild, ITabData prevTabData)

Parameters

Type	Name	Description
System.Windows.Forms.Form	mdiChild
ITabData	prevTabData

CreateMDITabPanel()

Creates a MDITabPanel for use within this Form.

Declaration

protected virtual MDITabPanel CreateMDITabPanel()

Returns

Type	Description
MDITabPanel	A MDITabPanel instance.

Remarks

This method inturn uses CreateMDITabPanel() to create the tab control.

Dispose(Boolean)

Overridden. See System.Windows.Forms.Control.Dispose(System.Boolean).

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

ListenToSplitterHost(SplitterHost)

Declaration

public void ListenToSplitterHost(SplitterHost splitterHost)

Parameters

Type	Name	Description
SplitterHost	splitterHost

OnPaintBackground(PaintEventArgs)

Declaration

protected override void OnPaintBackground(PaintEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e

OnVisibleChanged(EventArgs)

Declaration

protected override void OnVisibleChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

RemoveMdiChild(Form, Boolean)

Removes the mdi child form from this tab group.

Declaration

protected virtual bool RemoveMdiChild(Form mdiChild, bool removeFromHashtable)

Parameters

Type	Name	Description
System.Windows.Forms.Form	mdiChild	The child form to remove.
System.Boolean	removeFromHashtable	Internal flag.

Returns

Type	Description
System.Boolean	True if the form was found and removed; false otherwise.

ResumeChildActivation()

Declaration

protected virtual void ResumeChildActivation()

SetTooltip(Form, String)

Specifies the tooltip for a contained form.

Declaration

protected virtual void SetTooltip(Form mdiChild, string tooltip)

Parameters

Type	Name	Description
System.Windows.Forms.Form	mdiChild	The form.
System.String	tooltip	The tooltip.

Remarks

This tooltip will be set on the form's corresponding tab in its tab group.

Splitter_Moved(Object, SplitterHostEventArgs)

Declaration

protected void Splitter_Moved(object sender, SplitterHostEventArgs e)

Parameters

Type	Name	Description
System.Object	sender
SplitterHostEventArgs	e

SuspendChildActivation()

Declaration

protected virtual void SuspendChildActivation()

WndProc(ref Message)

Overridden. See System.Windows.Forms.Control.WndProc(System.Windows.Forms.Message@).

Declaration

protected override void WndProc(ref Message m)

Parameters

Type	Name	Description
System.Windows.Forms.Message	m

Implements

ITabHost