RibbonForm.Ribbon Property

Gets or sets a RibbonControl displayed within the form.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

[Browsable(false)]
[DefaultValue(null)]
public virtual RibbonControl Ribbon { get; set; }

VB.NET

<Browsable(False)>
<DefaultValue(Nothing)>
Public Overridable Property Ribbon As RibbonControl

Property Value

Type	Default	Description
RibbonControl	*null*	A RibbonControl displayed within the form.

Remarks

It’s possible to display one Ribbon Control within a RibbonForm at a time. Use the Ribbon property to access the RibbonControl displayed within the form.

When you create a RibbonControl at runtime and add it to the form’s Controls collection, the control is automatically assigned to the Ribbon property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Ribbon 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.

C#

XAF_how-to-access-the-documentmanager-barmanager-and-ribboncontrol-e4027/CS/TabsLayoutCustomization.Module.Win/Controllers/RibbonCustomizationWindowController.cs#L19

RibbonForm ribbonForm = Frame.Template as RibbonForm;
if (ribbonForm != null && ribbonForm.Ribbon != null)
{

VB.NET

XAF_how-to-access-the-documentmanager-barmanager-and-ribboncontrol-e4027/VB/TabsLayoutCustomization.Module.Win/Controllers/RibbonCustomizationWindowController.vb#L16

Dim ribbonForm As RibbonForm = TryCast(Frame.Template, RibbonForm)
If ribbonForm IsNot Nothing AndAlso ribbonForm.Ribbon IsNot Nothing Then
    Dim ribbon As RibbonControl = ribbonForm.Ribbon