windowsforms-devexpress-dot-xtrabars-dot-ribbon-dot-ribboncontrol-03056067.md
Gets the Ribbon BarManager.
Namespace : DevExpress.XtraBars.Ribbon
Assembly : DevExpress.XtraBars.v25.2.dll
NuGet Package : DevExpress.Win.Navigation
[Browsable(false)]
public virtual RibbonBarManager Manager { get; }
<Browsable(False)>
Public Overridable ReadOnly Property Manager As RibbonBarManager
| Type | Description |
|---|---|
| DevExpress.XtraBars.Ribbon.RibbonBarManager |
A DevExpress.XtraBars.Ribbon.RibbonBarManager object that represents the Ribbon BarManager.
|
Generally you will need this property when creating bar items using their constructors that have a manager parameter. Pass the object specified by the Manager property as the manager parameter. In this instance, the created bar item will be automatically added to the RibbonControl.Items collection. See the RibbonControl.Items topic for more information.
This example creates DevExpress WinForms RibbonControl and RibbonStatusBar:
RibbonControl contains the “Home” page, “File” and “Print” groups, and four commands (bar items).RibbonStatusBar displays the “Print” command. The “Print” command is aligned to the right.The following animation shows the result:
Prerequisites
In this example, the SvgImageCollection was created and populated with SVG images at design-time.
Note
When creating the Ribbon UI in code, ensure that the following requirements are met:
using System.Windows.Forms;
using DevExpress.XtraBars.Ribbon;
using DevExpress.XtraBars;
using DevExpress.XtraEditors;
namespace DXApplication
{
public partial class Form1 : XtraForm
{
public Form1()
{
InitializeComponent();
// Create the DevExpress RibbonControl
RibbonControl ribbon = new RibbonControl();
this.Controls.Add(ribbon);
/* Assign the SVG image collection to display images/icons within bar items.
* In this example, the svgImageCollection1 was created and populated with SVG images at design-time.
*/
ribbon.Images = svgImageCollection1;
// Create a Ribbon page.
RibbonPage pageHome = new RibbonPage("Home");
ribbon.Pages.Add(pageHome);
// Create a Ribbon page group.
RibbonPageGroup groupFile = new RibbonPageGroup("File");
pageHome.Groups.Add(groupFile);
// Create another Ribbon page group.
RibbonPageGroup groupPrint = new RibbonPageGroup("Print");
pageHome.Groups.Add(groupPrint);
// Create button items and add them to the 'File' group.
BarButtonItem itemNew = ribbon.Items.CreateButton("New");
// Ensures correct runtime layout (de)serialization.
itemNew.Id = ribbon.Manager.GetNewItemId();
// Specifies the image.
itemNew.ImageOptions.SvgImage = svgImageCollection1["new"];
itemNew.RibbonStyle = RibbonItemStyles.Large;
itemNew.ItemClick += ItemClick;
BarButtonItem itemOpen = ribbon.Items.CreateButton("Open");
itemOpen.Id = ribbon.Manager.GetNewItemId();
itemOpen.RibbonStyle = RibbonItemStyles.Large;
itemOpen.ImageOptions.SvgImage = svgImageCollection1["open"];
itemOpen.ItemClick += ItemClick;
groupFile.ItemLinks.AddRange(new BarItem[] { itemNew, itemOpen });
/* Create a button item using its constructor and add the button item to the 'Print' group.
* The constructor automatically adds the new item to the RibbonControl's Items collection.
*/
BarButtonItem itemPrint = new BarButtonItem(ribbon.Manager, "Print")
{
Id = ribbon.Manager.GetNewItemId(),
RibbonStyle = RibbonItemStyles.Large
};
itemPrint.ImageOptions.SvgImage = svgImageCollection1["print"];
itemPrint.ItemClick += ItemClick;
// Create a button item using the default constructor.
BarButtonItem itemPreview = new BarButtonItem()
{
Caption = "Preview",
RibbonStyle = RibbonItemStyles.Large,
Id = ribbon.Manager.GetNewItemId(),
};
itemPreview.ImageOptions.SvgImage = svgImageCollection1["preview"];
itemPreview.ItemClick += ItemClick;
// Add the 'Preview' item to the RibbonControl's Items collection.
ribbon.Items.Add(itemPreview);
groupPrint.ItemLinks.AddRange(new BarItem[] { itemPrint, itemPreview });
// Create a status bar with the 'Print' command.
RibbonStatusBar ribbonStatusBar = new RibbonStatusBar(ribbon)
{
Parent = this
};
BarItemLink linkPrint = ribbonStatusBar.ItemLinks.Add(itemPrint);
linkPrint.UserRibbonStyle = RibbonItemStyles.SmallWithoutText;
linkPrint.UserAlignment = BarItemLinkAlignment.Right;
}
void ItemClick(object sender, ItemClickEventArgs e)
{
XtraMessageBox.Show(string.Format("{0} command clicked.", e.Item.Caption), "Info", MessageBoxButtons.OK, MessageBoxIcon.Information);
}
}
}
Imports System.Windows.Forms
Imports DevExpress.XtraBars.Ribbon
Imports DevExpress.XtraBars
Imports DevExpress.XtraEditors
Namespace DXApplication
Partial Public Class Form1
Inherits XtraForm
Public Sub New()
InitializeComponent()
' Create the DevExpress RibbonControl
Dim ribbon As New RibbonControl()
Me.Controls.Add(ribbon)
' Assign the SVG image collection to display images/icons within bar items.
' * In this example, the svgImageCollection1 was created and populated with SVG images at design-time.
'
ribbon.Images = svgImageCollection1
' Create a Ribbon page.
Dim pageHome As New RibbonPage("Home")
ribbon.Pages.Add(pageHome)
' Create a Ribbon page group.
Dim groupFile As New RibbonPageGroup("File")
pageHome.Groups.Add(groupFile)
' Create another Ribbon page group.
Dim groupPrint As New RibbonPageGroup("Print")
pageHome.Groups.Add(groupPrint)
' Create button items and add them to the 'File' group.
Dim itemNew As BarButtonItem = ribbon.Items.CreateButton("New")
' Ensures correct runtime layout (de)serialization.
itemNew.Id = ribbon.Manager.GetNewItemId()
' Specifies the image.
itemNew.ImageOptions.SvgImage = svgImageCollection1("new")
itemNew.RibbonStyle = RibbonItemStyles.Large
AddHandler itemNew.ItemClick, AddressOf ItemClick
Dim itemOpen As BarButtonItem = ribbon.Items.CreateButton("Open")
itemOpen.Id = ribbon.Manager.GetNewItemId()
itemOpen.RibbonStyle = RibbonItemStyles.Large
itemOpen.ImageOptions.SvgImage = svgImageCollection1("open")
AddHandler itemOpen.ItemClick, AddressOf ItemClick
groupFile.ItemLinks.AddRange(New BarItem() { itemNew, itemOpen })
' Create a button item using its constructor and add the button item to the 'Print' group.
' * The constructor automatically adds the new item to the RibbonControl's Items collection.
'
Dim itemPrint As New BarButtonItem(ribbon.Manager, "Print") With {
.Id = ribbon.Manager.GetNewItemId(),
.RibbonStyle = RibbonItemStyles.Large
}
itemPrint.ImageOptions.SvgImage = svgImageCollection1("print")
AddHandler itemPrint.ItemClick, AddressOf ItemClick
' Create a button item using the default constructor.
Dim itemPreview As New BarButtonItem() With {
.Caption = "Preview",
.RibbonStyle = RibbonItemStyles.Large,
.Id = ribbon.Manager.GetNewItemId()
}
itemPreview.ImageOptions.SvgImage = svgImageCollection1("preview")
AddHandler itemPreview.ItemClick, AddressOf ItemClick
' Add the 'Preview' item to the RibbonControl's Items collection.
ribbon.Items.Add(itemPreview)
groupPrint.ItemLinks.AddRange(New BarItem() { itemPrint, itemPreview })
' Create a status bar with the 'Print' command.
Dim ribbonStatusBar As New RibbonStatusBar(ribbon) With {.Parent = Me}
Dim linkPrint As BarItemLink = ribbonStatusBar.ItemLinks.Add(itemPrint)
linkPrint.UserRibbonStyle = RibbonItemStyles.SmallWithoutText
linkPrint.UserAlignment = BarItemLinkAlignment.Right
End Sub
Private Sub ItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs)
XtraMessageBox.Show(String.Format("{0} command clicked.", e.Item.Caption), "Info", MessageBoxButtons.OK, MessageBoxIcon.Information)
End Sub
End Class
End Namespace
The following code snippets (auto-collected from DevExpress Examples) contain references to the Manager property.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.
BarManager IBarManagerHolder.BarManager {
get { return ribbonControl.Manager; }
}
SkinHelper.InitTrackWindowsAccentColor(bciTrackWindowsAccentColor);
SkinHelper.InitCustomAccentColor(Ribbon.Manager, bbiCustomColors);
bbiCustomColors.SuperTip = new SuperToolTip();
}
var barItem = new BarButtonItem(ribbon.Manager, caption);
barItem.ImageOptions.SvgImage = barImage;
winforms-spreadsheet-spell-check-cell-text/CS/SpreadsheetSpellchecking/Form1.cs#L27
BarManager BarManager => ribbonControl1.Manager;
buttonEdit.ButtonClick += ButtonEdit_ButtonClick;
urlBarItem = new BarEditItem(designer.Ribbon.Manager, buttonEdit);
urlBarItem.Caption = "URI Pattern";
End If
Dim barItem = New BarButtonItem(ribbon.Manager, caption)
barItem.ImageOptions.SvgImage = barImage
winforms-spreadsheet-spell-check-cell-text/VB/SpreadsheetSpellchecking/Form1.vb#L30
Get
Return ribbonControl1.Manager
End Get
AddHandler buttonEdit.ButtonClick, AddressOf ButtonEdit_ButtonClick
urlBarItem = New BarEditItem(designer.Ribbon.Manager, buttonEdit)
urlBarItem.Caption = "URI Pattern"
See Also