Class RibbonHeaderControl

Control representing header part of RibbonTabControl.

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

Constructors

RibbonHeaderControl()

Initializes a new instance of the RibbonHeaderControl class.

Declaration
public RibbonHeaderControl()

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 Description
System.Boolean

Groups

Gets collection of tab groups.

Declaration
public TabGroupsCollection Groups { get; }
Property Value
Type Description
TabGroupsCollection

GroupsCaptionColor1

Gets or sets the first color of caption gradient.

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

GroupsCaptionColor2

Gets or sets the second color of caption gradient.

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

GroupsCaptionFontColor

Gets or sets color of groups caption font.

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

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.

OnGroupAdded(Object, RibbonTabGroupEventArgs)

Adds new tab group to the controls.

Declaration
public void OnGroupAdded(object sender, RibbonTabGroupEventArgs args)
Parameters
Type Name Description
System.Object sender

Sender Object
RibbonTabGroupEventArgs args

RibbonTabGroupEventArgs that contains the event data.

OnGroupRemoved(Object, RibbonTabGroupEventArgs)

Lays out groups.

Declaration
public void OnGroupRemoved(object sender, RibbonTabGroupEventArgs args)
Parameters
Type Name Description
System.Object sender

Sender Object
RibbonTabGroupEventArgs args

RibbonTabGroupEventArgs that contains the event data.

OnItemAdded(Object, ToolStripItemEventArgs)

Initializes new tab item.

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

Sender Object
System.Windows.Forms.ToolStripItemEventArgs e

ToolstripItemEventArgs that contains the event data.

OnItemRemoved(Object, ToolStripItemEventArgs)

Performs layout.

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

Sender Object
System.Windows.Forms.ToolStripItemEventArgs e

ToolStripItemEventArgs that contains the event data.

OnLayout(LayoutEventArgs)

Lays out tab groups.

Declaration
protected override void OnLayout(LayoutEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.LayoutEventArgs e

LayoutEventArgs that contains the event data.

OnTabChanged(RibbonTabItem, RibbonTabItem)

Declaration
protected virtual void OnTabChanged(RibbonTabItem oldTab, RibbonTabItem newTab)
Parameters
Type Name Description
RibbonTabItem oldTab
RibbonTabItem newTab

OnTabChanging(RibbonTabItem, RibbonTabItem)

Declaration
protected virtual bool OnTabChanging(RibbonTabItem oldTab, RibbonTabItem newTab)
Parameters
Type Name Description
RibbonTabItem oldTab
RibbonTabItem newTab
Returns
Type Description
System.Boolean

OnTabItemCheckStateChanged(Object, EventArgs)

Occurs when TabItem check state changed.

Declaration
public void OnTabItemCheckStateChanged(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.

Events

RibbonTabItemAdded

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

Declaration
public event RibbonTabItemEventHandler RibbonTabItemAdded
Event Type
Type Description
RibbonTabItemEventHandler

TabChanged

Raised when tab is changed.

Declaration
public event RibbonTabItemChangedEventHandler TabChanged
Event Type
Type Description
RibbonTabItemChangedEventHandler

TabChanging

Raised when tab is about to be changed.

Declaration
public event RibbonTabItemChangingEventHandler TabChanging
Event Type
Type Description
RibbonTabItemChangingEventHandler

Implements