SpreadsheetControl.RibbonActions Property

Provides access to the collection of actions used to customize the SpreadhseetControl’s integrated ribbon UI.

Namespace: DevExpress.Xpf.Spreadsheet

Assembly: DevExpress.Xpf.Spreadsheet.v19.1.dll

Declaration

C#

public ObservableCollection<IControllerAction> RibbonActions { get; }

VB.NET

Public ReadOnly Property RibbonActions As ObservableCollection(Of IControllerAction)

Property Value

Type	Description
ObservableCollection<IControllerAction>	A collection of ribbon customization actions.

Remarks

Add the necessary customization actions to the RibbonActions collection to modify the SpreadsheetControl’s integrated ribbon UI. You can create, modify or remove ribbon tabs, groups and individual items, as shown in the example below.

For implementation details, refer to the Lesson 4 - Customize the Integrated Ribbon UI for the Spreadsheet tutorial.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-the-integrated-ribbon-for-the-wpf-spreadsheet-t511399.

MainWindow.xaml

<dxr:DXRibbonWindow x:Class="WpfSpreadsheet_RibbonCustomization.MainWindow" mc:Ignorable="d" Title="Spreadsheet" Height="480" Width="800" 
    xmlns:dxr="http://schemas.devexpress.com/winfx/2008/xaml/ribbon" 
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:dxb="http://schemas.devexpress.com/winfx/2008/xaml/bars"
    xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
    xmlns:dxsps="http://schemas.devexpress.com/winfx/2008/xaml/spreadsheet"
    xmlns:local="clr-namespace:WpfSpreadsheet_RibbonCustomization">
    <Grid>
        <dxsps:SpreadsheetControl CommandBarStyle="Ribbon" ShowFormulaBar="True" DocumentSource="pack://application:,,,/WpfSpreadsheet_RibbonCustomization;component/Document.xlsx">
            <dxsps:SpreadsheetControl.RibbonActions>
                <!--Make the Home tab the default tab in the application.-->
                <dxb:UpdateAction ElementName="{x:Static dxsps:DefaultBarItemNames.RibbonPage_Home}" PropertyName="IsSelected" Value="True"/>

                <!--Hide the Page Layout tab.-->
                <dxb:UpdateAction ElementName="{x:Static dxsps:DefaultBarItemNames.RibbonPage_PageLayout}" PropertyName="IsVisible" Value="False"/>

                <!--Hide the Formulas tab.-->
                <dxb:UpdateAction ElementName="{x:Static dxsps:DefaultBarItemNames.RibbonPage_Formulas}" PropertyName="IsVisible" Value="False"/>

                <!--Hide the Data tab.-->
                <dxb:UpdateAction ElementName="{x:Static dxsps:DefaultBarItemNames.RibbonPage_Data}" PropertyName="IsVisible" Value="False"/>

                <!--Hide the Show group on the View tab.-->
                <dxb:UpdateAction ElementName="{x:Static dxsps:DefaultBarItemNames.RibbonGroup_View_Show}" PropertyName="IsVisible" Value="False"/>

                <!--Hide the PivotTable item on the Insert tab, in the Tables group.-->
                <dxb:UpdateAction ElementName="{x:Static dxsps:DefaultBarItemNames.RibbonItem_Insert_Tables_PivotTable}" PropertyName="IsVisible" Value="False"/>

                <!--Remove the Review tab.-->
                <dxb:RemoveAction ElementName="{x:Static dxsps:DefaultBarItemNames.RibbonPage_Review}"/>

                <!--Remove the Window group on the View tab.-->
                <dxb:RemoveAction ElementName="{x:Static dxsps:DefaultBarItemNames.RibbonGroup_View_Window}"/>

                <!--Remove the Quick Print item on the File tab, in the Common group.-->
                <dxb:RemoveAction ElementName="{x:Static dxsps:DefaultBarItemNames.RibbonItem_File_Common_QuickPrint}"/>

                <!--Add a new group to the File tab.-->
                <!--The group contains a single button displaying information about this example.-->
                <dxb:InsertAction Index="2" ContainerName="{x:Static dxsps:DefaultBarItemNames.RibbonPage_File}">
                    <dxr:RibbonPageGroup Caption="Example">
                        <dxb:BarButtonItem Content="About"
                                           LargeGlyph="{dx:DXImageOffice2013 Image=Info_32x32.png}"
                                           ItemClick="About_ItemClick"/>
                    </dxr:RibbonPageGroup>
                </dxb:InsertAction>

                <!--Create the Comments group on the Insert tab and add the Comment button to it.-->
                <dxb:InsertAction Index="5" ContainerName="{x:Static dxsps:DefaultBarItemNames.RibbonPage_Insert}">
                    <dxr:RibbonPageGroup Caption="Comments">
                        <dxb:BarButtonItem Content="Comment"
                                           LargeGlyph="{dxsps:SpreadsheetSvgImage Name=InsertComment.svg, UseOfficeImage=True}"
                                           Command="{Binding RelativeSource={RelativeSource Self}, Path=(dxsps:SpreadsheetControl.Spreadsheet).CommandProvider.InsertComment}"/>
                    </dxr:RibbonPageGroup>
                </dxb:InsertAction>
            </dxsps:SpreadsheetControl.RibbonActions> 
        </dxsps:SpreadsheetControl>
    </Grid>
</dxr:DXRibbonWindow>

MainWindow.xaml.cs

using DevExpress.Xpf.Core;
using System.Windows;

namespace WpfSpreadsheet_RibbonCustomization
{
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : DevExpress.Xpf.Ribbon.DXRibbonWindow
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private void About_ItemClick(object sender, DevExpress.Xpf.Bars.ItemClickEventArgs e)
        {
            DXMessageBox.Show("This example demonstrates how to customize the WPF Spreadsheet's integrated ribbon UI.\n\nUse the SpreadsheetControl's RibbonActions collection to create, remove or modify ribbon elements.",
                "Spreadsheet Ribbon Customization", MessageBoxButton.OK, MessageBoxImage.Information);
        }
    }
}

MainWindow.xaml.vb

Imports DevExpress.Xpf.Core
Imports System.Windows

Namespace WpfSpreadsheet_RibbonCustomization
    ''' <summary>
    ''' Interaction logic for MainWindow.xaml
    ''' </summary>
    Partial Public Class MainWindow
        Inherits DevExpress.Xpf.Ribbon.DXRibbonWindow

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub About_ItemClick(ByVal sender As Object, ByVal e As DevExpress.Xpf.Bars.ItemClickEventArgs)
            DXMessageBox.Show("This example demonstrates how to customize the WPF Spreadsheet's integrated ribbon UI." & ControlChars.Lf & ControlChars.Lf & "Use the SpreadsheetControl's RibbonActions collection to create, remove or modify ribbon elements.", "Spreadsheet Ribbon Customization", MessageBoxButton.OK, MessageBoxImage.Information)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RibbonActions 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#

how-to-customize-the-integrated-ribbon-for-the-wpf-spreadsheet-t511399/CS/WpfSpreadsheet_RibbonCustomization/MainWindow.xaml#L13

<dxsps:SpreadsheetControl CommandBarStyle="Ribbon" ShowFormulaBar="True" DocumentSource="pack://application:,,,/WpfSpreadsheet_RibbonCustomization;component/Document.xlsx">
    <dxsps:SpreadsheetControl.RibbonActions>
        <!--Make the Home tab the default tab in the application.-->

wpf-spreadsheet-how-to-perform-a-mail-merge-t618180/CS/WpfSpreadsheetMailMerge/MainWindow.xaml#L15

                      DocumentSource="pack://application:,,,/WpfSpreadsheetMailMerge;component/MailMergeTemplate.xlsx">
<dxsps:SpreadsheetControl.RibbonActions>
    <dxb:InsertAction Index="8">