Back to Devexpress

SpreadsheetControl.CreateRibbon() Method

windowsforms-devexpress-dot-xtraspreadsheet-dot-spreadsheetcontrol-36626d74.md

latest3.3 KB
Original Source

SpreadsheetControl.CreateRibbon() Method

Creates a RibbonControl with all SpreadsheetControl-specific ribbon tabs.

Namespace : DevExpress.XtraSpreadsheet

Assembly : DevExpress.XtraSpreadsheet.v25.2.dll

NuGet Package : DevExpress.Win.Spreadsheet

Declaration

csharp
public RibbonControl CreateRibbon()
vb
Public Function CreateRibbon As RibbonControl

Returns

TypeDescription
RibbonControl

The created ribbon.

|

Remarks

Use the CreateRibbon method overloads to create a ribbon UI that allows end users to perform basic operations in the SpreadsheetControl. The current method creates all available spreadsheet ribbon tabs, except for the Mail Merge tab. You can use the AddToolbarToMenuManager method to add this tab to your ribbon, as shown below:

csharp
using DevExpress.XtraBars.Ribbon;
using DevExpress.XtraSpreadsheet;
// ...

public Form1()
{
    InitializeComponent();

    // Create the Spreadsheet's ribbon menu.
    RibbonControl ribbon = spreadsheetControl1.CreateRibbon();
    // Add the Mail Merge tab to the ribbon.
    spreadsheetControl1.AddToolbarToMenuManager(SpreadsheetToolbarType.MailMerge);
    // Specify the active tab.
    ribbon.SelectedPage = ribbon.Pages["Home"];
    this.Controls.Add(ribbon);
}
vb
Imports DevExpress.XtraBars.Ribbon
Imports DevExpress.XtraSpreadsheet
' ...

Public Class Form1
    Public Sub New()
        InitializeComponent()

        ' Create the Spreadsheet's ribbon menu.
        Dim ribbon As RibbonControl = spreadsheetControl1.CreateRibbon()
        ' Add the Mail Merge tab to the ribbon.
        spreadsheetControl1.AddToolbarToMenuManager(SpreadsheetToolbarType.MailMerge)
        ' Specify the active tab.
        ribbon.SelectedPage = ribbon.Pages("Home")
        Me.Controls.Add(ribbon)
    End Sub
End Class

To create a ribbon at design time, select the Create Ribbon item in the SpreadsheetControl’s smart tag menu (see Get Started with the WinForms Spreadsheet Control for details).

You can also use the CreateBars method to add a toolbar menu to the SpreadsheetControl.

See Also

SpreadsheetControl Class

SpreadsheetControl Members

DevExpress.XtraSpreadsheet Namespace