Class RibbonTabBarHeader

RibbonTabBar Header

Inheritance
System.Object
RibbonTabBarHeader
Namespace: Syncfusion.Windows.Forms.Tools.Controls.RibbonTabBar
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class RibbonTabBarHeader : UserControl, IRibbonHeaderControl

Constructors

RibbonTabBarHeader()

Initializes a new instance of the RibbonTabBarHeader class.

Declaration
public RibbonTabBarHeader()

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 caption font.

Declaration
public Color GroupsCaptionFontColor { get; set; }
Property Value
Type
System.Drawing.Color

LeftPanel

Gets left panel.

Declaration
public ToolStrip LeftPanel { get; }
Property Value
Type
System.Windows.Forms.ToolStrip

TabHeaderControl

Gets ribbon header control.

Declaration
protected RibbonHeaderControl TabHeaderControl { get; }
Property Value
Type
RibbonHeaderControl

TopPanel

Gets top panel.

Declaration
public ToolStrip TopPanel { get; }
Property Value
Type
System.Windows.Forms.ToolStrip

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.

GetParentForChildsTransparentRendering()

Returns control that has to be shown behind transparent childs.

Declaration
public Control GetParentForChildsTransparentRendering()
Returns
Type Description
System.Windows.Forms.Control

Required control.

GetTabsHeader()

Returns header for tab control.

Declaration
public Control GetTabsHeader()
Returns
Type Description
System.Windows.Forms.Control

Required tab header.

Events

RibbonTabItemAdded

Raised when newly created tab item is added to the control.

Declaration
public event RibbonTabItemEventHandler RibbonTabItemAdded
Event Type
Type
RibbonTabItemEventHandler

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

Implements