Interface IRibbonHeaderControl
Interface for RibbonHeaderControl.
Namespace: Syncfusion.Windows.Forms.Tools.Controls.RibbonTabControl.Interfaces
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public interface IRibbonHeaderControlProperties
FillWidthWithItems
Gets or sets a value indicating whether with of control should be filled with RibbonTabItems.
Declaration
bool FillWidthWithItems { get; set; }Property Value
| Type |
|---|
| System.Boolean |
Groups
Gets collection of tab groups.
Declaration
TabGroupsCollection Groups { get; }Property Value
| Type |
|---|
| TabGroupsCollection |
GroupsCaptionColor1
Gets or sets the first color of caption gradiend.
Declaration
Color GroupsCaptionColor1 { get; set; }Property Value
| Type |
|---|
| System.Drawing.Color |
GroupsCaptionColor2
Gets or sets the second color of caption gradiend.
Declaration
Color GroupsCaptionColor2 { get; set; }Property Value
| Type |
|---|
| System.Drawing.Color |
GroupsCaptionFontColor
Gets or sets color of caption font.
Declaration
Color GroupsCaptionFontColor { get; set; }Property Value
| Type |
|---|
| System.Drawing.Color |
Methods
AddGroup()
Adds new ribbon tab group.
Declaration
RibbonTabGroup AddGroup()Returns
| Type | Description |
|---|---|
| RibbonTabGroup | Newly created tab group. |
AddGroup(RibbonTabGroup)
Adds ribbon tab group to the control.
Declaration
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
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
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
RibbonTabItem AddTabItem()Returns
| Type | Description |
|---|---|
| RibbonTabItem | Newly created tab item. |
AddTabItem(RibbonTabGroup)
Adds new ribbon tab item to the specified tab group.
Declaration
RibbonTabItem AddTabItem(RibbonTabGroup group)Parameters
| Type | Name | Description |
|---|---|---|
| RibbonTabGroup | group | RibbonTabGroup that has to host new item. |
Returns
| Type | Description |
|---|---|
| RibbonTabItem | Newly created RibbonTabItem. |
GetParentForChildsTransparentRendering()
Returns control that has to be shown behind transparent childs.
Declaration
Control GetParentForChildsTransparentRendering()Returns
| Type | Description |
|---|---|
| System.Windows.Forms.Control | Required control. |
GetTabsHeader()
Returns header for tab control.
Declaration
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
event RibbonTabItemEventHandler RibbonTabItemAddedEvent Type
TabChanged
Raised when tab is changed.
Declaration
event RibbonTabItemChangedEventHandler TabChangedEvent Type
TabChanging
Raised when tab is about to be changed.
Declaration
event RibbonTabItemChangingEventHandler TabChanging