Getting Started with WPF Spreadsheet (SfSpreadsheet)

24 Jul 20269 minutes to read

This section briefly explains how to include the WPF Spreadsheet Editor component in a WPF application using Visual Studio.

Prerequisites

Create a new WPF App in Visual Studio

You can create a WPF Application using Visual Studio via Microsoft Templates or the Syncfusion® WPF.

Assemblies Deployment

To add a WPF spreadsheet component to your application, install it via NuGet packages (Recommended) or manually add the required assemblies to the project.

Install Syncfusion® WPF Spreadsheet NuGet packages

To add the WPF Spreadsheet component to the application, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for and install:

• Syncfusion.SfSpreadsheet.WPF

To ensure the control is styled correctly, install the theme package:

• Syncfusion.Themes.Windows11Light.WPF

The following table lists the optional NuGet packages that enable additional features in the SfSpreadsheet control.

Optional NuGet Packages Description

Syncfusion.SfSpreadsheetHelper.WPF

 Contains the classes that are responsible for importing charts and sparklines into SfSpreadsheet.

Syncfusion.ExcelChartToImageConverter.WPF

 Contains the classes that are responsible for converting charts as images.

Syncfusion.SfChart.WPF

 Contains the classes that are responsible for importing charts such as Line, Pie, Column, and Bar charts. Sparklines are handled by Syncfusion.SfSpreadsheetHelper.WPF, not by this package.

Add Syncfusion® WPF Spreadsheet Assemblies

The table below lists the assemblies required to be added to the project when the WPF Spreadsheet control is used in your application. All assemblies in this table are required.

Assembly Description
Syncfusion.SfCellGrid.WPF.dll Contains the base and fundamental classes that hold the underlying architecture for displaying cells with virtualized behavior and cell selection/interaction.
Syncfusion.SfGridCommon.WPF.dll Contains the classes that hold the properties and functions of the scroll viewer and disposable elements.
Syncfusion.SfSpreadsheet.WPF.dll Contains the classes that handle all the UI operations of SfSpreadsheet, such as importing sheets and applying formulas/styles.
Syncfusion.Shared.WPF.dll Contains the classes that hold controls like Color pickers, Chromeless window, ComboBoxAdv, DateTimeEdit, etc.
Syncfusion.Tools.WPF.dll Contains the classes that hold controls like TabControlExt, TabItemExt, Gallery, GroupBar, and TabSplitter, which are used in SfSpreadsheet.
Syncfusion.XlsIO.Base.dll Contains the base classes that are responsible for reading and writing Excel files, worksheet manipulations, and formula calculations.

Below are the additional DLLs required for applying themes and skinning to the SfSpreadsheet control:

Assembly Description
Syncfusion.Themes.Windows11Light.WPF.dll Contains the Windows 11 Light theme style for Syncfusion WPF controls.
Syncfusion.SfSkinManager.WPF.dll Contains the SfSkinManager that helps to apply different themes to Syncfusion WPF controls.

NOTE

Add these references to your project to use the skinning and theming capabilities of the SfSpreadsheet.

Optional Assemblies

The following table lists the optional assemblies that enable additional features in the SfSpreadsheet control.

Optional Assemblies Description
Syncfusion.SfSpreadsheetHelper.WPF.dll Contains the classes that are responsible for importing charts and sparklines into SfSpreadsheet.
Syncfusion.ExcelChartToImageConverter.WPF.dll Contains the classes that are responsible for converting charts as images.
Syncfusion.SfChart.WPF.dll Contains the classes that are responsible for importing charts such as Line, Pie, Column, and Bar charts. Sparklines are handled by Syncfusion.SfSpreadsheetHelper.WPF, not by this assembly.
Syncfusion.ExcelToPDFConverter.Base.dll Contains the base and fundamental classes that are responsible for converting Excel to PDF.
Syncfusion.Pdf.Base.dll Contains the base and fundamental classes for creating PDF.

Add WPF Spreadsheet component

WPF Spreadsheet control can be added to an application either through the designer (XAML) or programmatically using code.

1.Add the theme and the SfSkinManager namespace to style the control correctly. Include the SfSkinManager namespace in the XAML code and apply the desired theme.

<Window x:Class="YourNamespace.MainWindow"
            xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
            xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
            xmlns:syncfusionskin="clr-namespace:Syncfusion.SfSkinManager;assembly=Syncfusion.SfSkinManager.WPF"
            syncfusionskin:SfSkinManager.Theme="{syncfusionskin:SkinManagerExtension ThemeName=Windows11Light}">

    </Window>

2.Open the Visual Studio Toolbox. Navigate to the Syncfusion® Controls tab and find the SfSpreadsheet and SfSpreadsheetRibbon toolbox items. (If the Syncfusion tab is missing, install the controls using the Syncfusion® WinForms/WPF installer and restart Visual Studio.)

![WPF Spreadsheet Getting-Started](Getting-Started_images/wpf-spreadsheet-getting-started.jpeg)

3.Drag SfSpreadsheet and SfSpreadsheetRibbon from the Toolbox and drop them in the Designer area.

![WPF Spreadsheet Interaction with Ribbon](Getting-Started_images/wpf-spreadsheet-interaction-with-ribbon.jpeg)

<Window x:Class="YourNamespace.MainWindow"
            xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
            xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    	xmlns:syncfusion="clr-namespace:Syncfusion.UI.Xaml.Spreadsheet;assembly=Syncfusion.SfSpreadsheet.WPF"
            xmlns:syncfusionskin="clr-namespace:Syncfusion.SfSkinManager;assembly=Syncfusion.SfSkinManager.WPF"
            syncfusionskin:SfSkinManager.Theme="{syncfusionskin:SkinManagerExtension ThemeName=Windows11Light}">
        <Grid>
    	<syncfusion:SfSpreadsheetRibbon />
        </Grid>
    </Window>

4.Spreadsheet can be added to the application by dragging SfSpreadsheet to the Designer area.

<Window x:Class="YourNamespace.MainWindow"
            xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
            xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    	xmlns:syncfusion="clr-namespace:Syncfusion.UI.Xaml.Spreadsheet;assembly=Syncfusion.SfSpreadsheet.WPF"
            xmlns:syncfusionskin="clr-namespace:Syncfusion.SfSkinManager;assembly=Syncfusion.SfSkinManager.WPF"
            syncfusionskin:SfSkinManager.Theme="{syncfusionskin:SkinManagerExtension ThemeName=Windows11Light}">

        <Grid>
    	<syncfusion:SfSpreadsheet x:Name = spreadsheet />
        </Grid>
    </Window>
N> Declare a name for the Spreadsheet component (for example, `x:Name="spreadsheet"`) so that it can be referenced from the Ribbon.

![WPF Spreadsheet Drag and Drop](Getting-Started_images/wpf-spreadsheet-dragdrop.jpeg)

5.To make an interaction between Ribbon items and SfSpreadsheet, bind the SfSpreadsheet as DataContext to the SfSpreadsheetRibbon.

<Window x:Class="YourNamespace.MainWindow"
            xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
            xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
            xmlns:syncfusion="clr-namespace:Syncfusion.UI.Xaml.Spreadsheet;assembly=Syncfusion.SfSpreadsheet.WPF"
            xmlns:syncfusionskin="clr-namespace:Syncfusion.SfSkinManager;assembly=Syncfusion.SfSkinManager.WPF"
            syncfusionskin:SfSkinManager.Theme="{syncfusionskin:SkinManagerExtension ThemeName=Windows11Light}">

        <Grid>
    	<syncfusion:SfSpreadsheetRibbon DataContext= "{Binding ElementName=spreadsheet}"  />
    	<syncfusion:SfSpreadsheet x:Name = spreadsheet />
        </Grid>
   </Window>

Spreadsheet is available in the following namespace “Syncfusion.UI.Xaml.Spreadsheet” and it can be created programmatically by using XAML

<Window x:Class="WpfApp1.MainWindow"
        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:syncfusion="http://schemas.syncfusion.com/wpf"
        xmlns:syncfusionskin ="clr-namespace:Syncfusion.SfSkinManager;assembly=Syncfusion.SfSkinManager.WPF"
        syncfusionskin:SfSkinManager.Theme="{syncfusionskin:SkinManagerExtension ThemeName=Windows11Light}"
        mc:Ignorable="d">
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"/>
            <RowDefinition Height="*"/>
        </Grid.RowDefinitions>
        <syncfusion:SfSpreadsheetRibbon Grid.Row="0" DataContext="{Binding ElementName=spreadsheet}"  />
        <syncfusion:SfSpreadsheet Name="spreadsheet" Grid.Row="1" />
    </Grid>
</Window>
using Syncfusion.SfSkinManager;
using Syncfusion.UI.Xaml.Spreadsheet;
....

public MainWindow()
{
    InitializeComponent();

    SfSkinManager.ApplyThemeAsDefaultStyle = true;

    SfSkinManager.SetTheme(this, new Theme("Windows11Light"));

    Grid grid = new Grid();

    grid.RowDefinitions.Add(new RowDefinition { Height = GridLength.Auto });

    grid.RowDefinitions.Add(new RowDefinition { Height = new GridLength(1, GridUnitType.Star) });

    SfSpreadsheet spreadsheet = new SfSpreadsheet();

    SfSpreadsheetRibbon ribbon = new SfSpreadsheetRibbon() { SfSpreadsheet = spreadsheet };

    Grid.SetRow(ribbon, 0);

    Grid.SetRow(spreadsheet, 1);

    grid.Children.Add(ribbon);

    grid.Children.Add(spreadsheet);

    this.Content = grid;
}

Run the application

Press Ctrl+F5 in Visual Studio to launch the application.The output will appear as follows:

WPF Spreadsheet Control

Next steps

To learn how to create, open, and save files in the WPF Spreadsheet Component, see Workbook Operations.

Find the complete WPF Spreadsheet sample on GitHub.

For the full WPF Spreadsheet Editor component overview, features, pricing, and documentation, visit the WPF Spreadsheet Editor page.

See Also