Version

Caption Property (Ribbon)

Returns or sets the caption that will be displayed in the ribbon caption area.
Syntax
'Declaration
 
Public Property Caption As String
public string Caption {get; set;}
Remarks

The Caption property is used to determine the caption that is displayed within the caption area of the ribbon. By default, this property is set to null and will resolve to using the Text property of the UltraToolbarsManager.DockWithinContainer if it is a form, otherwise it will resolve to an empty string.

Example
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinToolBars

' Show the Ribbon
Me.UltraToolbarsManager1.Ribbon.Visible = True

' Set the ribbon caption
Me.UltraToolbarsManager1.Ribbon.Caption = "This is the ribbon caption when the form is active"
Me.UltraToolbarsManager1.Ribbon.CaptionInactive = "This is the ribbon caption when the form is inactive"

' Set the Ribbon IsMinimized to false
Me.UltraToolbarsManager1.Ribbon.IsMinimized = False

' Add some tabs
Me.UltraToolbarsManager1.Ribbon.Tabs.Clear()
Dim ribbonTab1 As RibbonTab = Me.UltraToolbarsManager1.Ribbon.Tabs.Add("ribbon1")
Dim ribbonTab2 As RibbonTab = Me.UltraToolbarsManager1.Ribbon.Tabs.Add("ribbon2")
Dim ribbonTab3 As RibbonTab = Me.UltraToolbarsManager1.Ribbon.Tabs.Add("ribbon3")
Dim ribbonTab4 As RibbonTab = Me.UltraToolbarsManager1.Ribbon.Tabs.Add("ribbon4")
Dim ribbonTab5 As RibbonTab = Me.UltraToolbarsManager1.Ribbon.Tabs.Add("ribbon5")
Dim ribbonTab6 As RibbonTab = Me.UltraToolbarsManager1.Ribbon.Tabs.Add("ribbon6")

' Add some groups
Dim ribbonGroupClipboard As RibbonGroup = ribbonTab1.Groups.Add("Clipboard")
Dim ribbonGroupFont As RibbonGroup = ribbonTab1.Groups.Add("Font")
Dim ribbonGroupStyles As RibbonGroup = ribbonTab1.Groups.Add("Styles")

' Create some Contextual Tab Groups and put some tabs into groups. 
Me.UltraToolbarsManager1.Ribbon.ContextualTabGroups.Clear()

Me.UltraToolbarsManager1.Ribbon.ContextualTabGroups.Add("contextualTabGroup1")
ribbonTab3.ContextualTabGroupKey = "contextualTabGroup1"
ribbonTab4.ContextualTabGroupKey = "contextualTabGroup1"

Me.UltraToolbarsManager1.Ribbon.ContextualTabGroups.Add("contextualTabGroup2")
ribbonTab5.ContextualTabGroupKey = "contextualTabGroup2"
ribbonTab6.ContextualTabGroupKey = "contextualTabGroup2"
Me.UltraToolbarsManager1.Ribbon.ContextualTabGroups("contextualTabGroup2").Visible = False

' Set the selected ribbon tab
Me.UltraToolbarsManager1.Ribbon.SelectedTab = ribbonTab1

' Set the border style for the Ribbon Groups
Me.UltraToolbarsManager1.Ribbon.GroupBorderStyle = UIElementBorderStyle.Dotted
using Infragistics.Win;
using Infragistics.Win.UltraWinToolBars;


// Show the Ribbon
this.ultraToolbarsManager1.Ribbon.Visible = true;

// Set the ribbon caption
this.ultraToolbarsManager1.Ribbon.Caption = "This is the ribbon caption when the form is active";
this.ultraToolbarsManager1.Ribbon.CaptionInactive = "This is the ribbon caption when the form is inactive";

// Set the Ribbon IsMinimized to false
this.ultraToolbarsManager1.Ribbon.IsMinimized = false;

// Add some tabs
this.ultraToolbarsManager1.Ribbon.Tabs.Clear();
RibbonTab ribbonTab1 = this.ultraToolbarsManager1.Ribbon.Tabs.Add("ribbon1");
RibbonTab ribbonTab2 = this.ultraToolbarsManager1.Ribbon.Tabs.Add("ribbon2");
RibbonTab ribbonTab3 = this.ultraToolbarsManager1.Ribbon.Tabs.Add("ribbon3");
RibbonTab ribbonTab4 = this.ultraToolbarsManager1.Ribbon.Tabs.Add("ribbon4");
RibbonTab ribbonTab5 = this.ultraToolbarsManager1.Ribbon.Tabs.Add("ribbon5");
RibbonTab ribbonTab6 = this.ultraToolbarsManager1.Ribbon.Tabs.Add("ribbon6");

// Add some groups
RibbonGroup ribbonGroupClipboard = ribbonTab1.Groups.Add("Clipboard");
RibbonGroup ribbonGroupFont = ribbonTab1.Groups.Add("Font");
RibbonGroup ribbonGroupStyles = ribbonTab1.Groups.Add("Styles");

// Create some Contextual Tab Groups and put some tabs into groups. 
this.ultraToolbarsManager1.Ribbon.ContextualTabGroups.Clear();

this.ultraToolbarsManager1.Ribbon.ContextualTabGroups.Add("contextualTabGroup1");
ribbonTab3.ContextualTabGroupKey = "contextualTabGroup1";
ribbonTab4.ContextualTabGroupKey = "contextualTabGroup1";

this.ultraToolbarsManager1.Ribbon.ContextualTabGroups.Add("contextualTabGroup2");
ribbonTab5.ContextualTabGroupKey = "contextualTabGroup2";
ribbonTab6.ContextualTabGroupKey = "contextualTabGroup2";
this.ultraToolbarsManager1.Ribbon.ContextualTabGroups["contextualTabGroup2"].Visible = false;

// Set the selected ribbon tab
this.ultraToolbarsManager1.Ribbon.SelectedTab = ribbonTab1;

// Set the border style for the Ribbon Groups
this.ultraToolbarsManager1.Ribbon.GroupBorderStyle = UIElementBorderStyle.Dotted;
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also