Class RibbonTabControl

Control that allows grouping child controls into tab pages.

Inheritance

System.Object

RibbonTabControl

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class RibbonTabControl : UserControl

Constructors

RibbonTabControl()

Initializes a new instance of the RibbonTabControl class.

Declaration

public RibbonTabControl()

Properties

FillWidthWithItems

Gets or sets a value indicating whether with of control should be filled with RibbonTabItems.

Declaration

public bool FillWidthWithItems { get; set; }

Property Value

Type
System.Boolean

Groups

Gets collection of tab groups.

Declaration

public TabGroupsCollection Groups { get; }

Property Value

Type
TabGroupsCollection

GroupsCaptionColor1

Gets or sets the first color of caption gradient.

Declaration

public Color GroupsCaptionColor1 { get; set; }

Property Value

Type
System.Drawing.Color

GroupsCaptionColor2

Gets or sets the second color of caption gradient.

Declaration

public Color GroupsCaptionColor2 { get; set; }

Property Value

Type
System.Drawing.Color

GroupsCaptionFontColor

Gets or sets color of groups caption font.

Declaration

public Color GroupsCaptionFontColor { get; set; }

Property Value

Type
System.Drawing.Color

Header

Gets header control.

Declaration

protected IRibbonHeaderControl Header { get; }

Property Value

Type
IRibbonHeaderControl

HeaderDock

Gets or sets Docking style of the header.

Declaration

public DockStyle HeaderDock { get; set; }

Property Value

Type
System.Windows.Forms.DockStyle

HeaderSize

Gets or sets Size of the header.

Declaration

public Size HeaderSize { get; set; }

Property Value

Type
System.Drawing.Size

Methods

AddGroup()

Adds new ribbon tab group.

Declaration

public RibbonTabGroup AddGroup()

Returns

Type	Description
RibbonTabGroup	Newly created tab group.

AddGroup(RibbonTabGroup)

Adds ribbon tab group to the control.

Declaration

public RibbonTabGroup AddGroup(RibbonTabGroup group)

Parameters

Type	Name	Description
RibbonTabGroup	group	RibbonTabGroup instance to be added.

Returns

Type	Description
RibbonTabGroup	Added RibbonTabGroup instance.

AddItem(ToolStripItem)

Adds toolstrip item to the newly created tab group.

Declaration

public ToolStripItem AddItem(ToolStripItem item)

Parameters

Type	Name	Description
System.Windows.Forms.ToolStripItem	item	ToolStripItem instance to be added.

Returns

Type	Description
System.Windows.Forms.ToolStripItem	Added ToolStripItem instance.

AddItem(ToolStripItem, RibbonTabGroup)

Adds toolstrip item to the specified tab group.

Declaration

public ToolStripItem AddItem(ToolStripItem item, RibbonTabGroup group)

Parameters

Type	Name	Description
System.Windows.Forms.ToolStripItem	item	ToolStripItem instance to be added.
RibbonTabGroup	group	RibbonTabGroup that has to host the item.

Returns

Type	Description
System.Windows.Forms.ToolStripItem	Added ToolStripItem instance.

AddTabItem()

Adds new ribbon tab item to the new ribbon tab group.

Declaration

public RibbonTabItem AddTabItem()

Returns

Type	Description
RibbonTabItem	Newly created tab item.

AddTabItem(RibbonTabGroup)

Adds new ribbon tab item to the specified tab group.

Declaration

public RibbonTabItem AddTabItem(RibbonTabGroup group)

Parameters

Type	Name	Description
RibbonTabGroup	group	RibbonTabGroup that has to host new item.

Returns

Type	Description
RibbonTabItem	Newly created RibbonTabItem..

Dispose(Boolean)

Clean up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true if managed resources should be disposed; otherwise, false.

GetGroupAtScreenPoint(Point)

Gets tab group located at the specified point in screen coordinates.

Declaration

protected RibbonTabGroup GetGroupAtScreenPoint(Point p)

Parameters

Type	Name	Description
System.Drawing.Point	p	Point in screen coordinates.

Returns

Type	Description
RibbonTabGroup	Group located at the specified point.

GetHeader()

Retrieves header for the control.

Declaration

protected virtual IRibbonHeaderControl GetHeader()

Returns

Type	Description
IRibbonHeaderControl	IRibbonHeaderControl instance.

OnControlAdded(ControlEventArgs)

Correctly docks new tab page.

Declaration

protected override void OnControlAdded(ControlEventArgs e)

Parameters

Type	Name	Description
System.Windows.Forms.ControlEventArgs	e	ControlEventArgs that contains the event data.

OnLoad(EventArgs)

Shows initial page.

Declaration

protected override void OnLoad(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	EventArgs that contains the event data.

ResetGroupsCaptionColor1()

Resets the GroupsCaptionColor1 property to it's default value.

Declaration

public void ResetGroupsCaptionColor1()

ResetGroupsCaptionColor2()

Resets the GroupsCaptionColor2 property to it's default value.

Declaration

public void ResetGroupsCaptionColor2()

ResetGroupsCaptionFontColor()

Resets the GroupsCaptionFontColor property to it's default value.

Declaration

public void ResetGroupsCaptionFontColor()

ShouldSerializeGroupsCaptionColor1()

Indicates whether the current value of the GroupsCaptionColor1 property is to be serialized.

Declaration

public bool ShouldSerializeGroupsCaptionColor1()

Returns

Type
System.Boolean

ShouldSerializeGroupsCaptionColor2()

Indicates whether the current value of the GroupsCaptionColor2 property is to be serialized.

Declaration

public bool ShouldSerializeGroupsCaptionColor2()

Returns

Type
System.Boolean

ShouldSerializeGroupsCaptionFontColor()

Indicates whether the current value of the GroupsCaptionFontColor property is to be serialized.

Declaration

public bool ShouldSerializeGroupsCaptionFontColor()

Returns

Type
System.Boolean

Events

TabChanged

Raised when tab is changed.

Declaration

public event RibbonTabItemChangedEventHandler TabChanged

Event Type

Type
RibbonTabItemChangedEventHandler

TabChanging

Raised when tab is about to be changed.

Declaration

public event RibbonTabItemChangingEventHandler TabChanging

Event Type

Type
RibbonTabItemChangingEventHandler