SpreadsheetControl Class

A spreadsheet control.

Namespace: DevExpress.Xpf.Spreadsheet

Assembly: DevExpress.Xpf.Spreadsheet.v17.2.dll

Declaration

C#

public class SpreadsheetControl :
    Control,
    IGestureClient,
    IMouseWheelScrollClient,
    ILogicalOwner,
    IInputElement,
    IOfficeFontSizeProvider,
    ISpreadsheetDocumentServer,
    IDisposable,
    IInnerSpreadsheetControlOwner,
    ISpreadsheetControl,
    ISpreadsheetComponent,
    IBatchUpdateable,
    IServiceContainer,
    IServiceProvider,
    ISupportsContentChanged,
    IWin32Window,
    IInnerSpreadsheetDocumentServerOwner,
    INotifyPropertyChanged,
    ICommandAwareControl<SpreadsheetCommandId>

VB.NET

Public Class SpreadsheetControl
    Inherits Control
    Implements IGestureClient,
               IMouseWheelScrollClient,
               ILogicalOwner,
               IInputElement,
               IOfficeFontSizeProvider,
               ISpreadsheetDocumentServer,
               IDisposable,
               IInnerSpreadsheetControlOwner,
               ISpreadsheetControl,
               ISpreadsheetComponent,
               IBatchUpdateable,
               IServiceContainer,
               IServiceProvider,
               ISupportsContentChanged,
               IWin32Window,
               IInnerSpreadsheetDocumentServerOwner,
               INotifyPropertyChanged,
               ICommandAwareControl(Of SpreadsheetCommandId)

Related API Members

The following members accept/return SpreadsheetControl objects:

• SpreadsheetControl.GetSpreadsheet(DependencyObject)

Remarks

The SpreadsheetControl class specifies a visual control to create, load, modify, print, save and convert spreadsheet files.

A document loaded into the spreadsheet control is a workbook that exposes the IWorkbook interface and is accessible with the SpreadsheetControl.Document property. The IWorkbook interface provides a comprehensive set of properties and methods to manipulate worksheets, rows, columns and cells of the corresponding workbook. See the Examples section for details.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SpreadsheetControl class.

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#

wpf-spreadsheetcontrol-examples-e4975/CS/SpreadsheetControl_WPF_Examples/SpreadsheetActions/RowAndColumnActions.cs#L10

#region Actions
public static Action<SpreadsheetControl> FreezeRowAction = FreezeRow;
public static Action<SpreadsheetControl> FreezeColumnAction = FreezeColumn;

how-to-customize-cell-appearance-in-wpf-spreadsheet-based-on-custom-logic-e4985/CS/CellTemplateSelectorExample/MainWindow.xaml.cs#L25

    CellData data = item as CellData;
    return CanApplyCustomTemplate(data.Cell.GetReferenceA1()) ? GetCellTemplate(data.Cell, (SpreadsheetControl)container) : base.SelectTemplate(item, container);
}

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

previewWindow.Title = "Mail Merge Preview";
SpreadsheetControl control = new SpreadsheetControl();
control.Document.LoadDocument("MailMergeResult.xlsx");

wpf-spreadsheet-how-to-replace-standard-command-with-custom-command/CS/WpfSpreadsheet_CustomCommand/CustomCommandService.cs#L17

}
public SpreadsheetControl Control { get; set; }

VB.NET

wpf-spreadsheetcontrol-examples-e4975/VB/SpreadsheetControl_WPF_Examples/SpreadsheetActions/RowAndColumnActions.vb#L10

#Region "Actions"
Public Shared FreezeRowAction As Action(Of SpreadsheetControl) = AddressOf FreezeRow
Public Shared FreezeColumnAction As Action(Of SpreadsheetControl) = AddressOf FreezeColumn

how-to-assign-custom-in-place-editors-to-worksheet-cells-wpf-spreadsheet-t385458/VB/WpfSpreadsheet_CustomCellEditors/MainWindow.xaml.vb#L12

InitializeComponent()
spreadsheetControl.LoadDocument("Documents\Document.xlsx", DocumentFormat.Xlsx)

how-to-customize-cell-appearance-in-wpf-spreadsheet-based-on-custom-logic-e4985/VB/CellTemplateSelectorExample/MainWindow.xaml.vb#L23

    Dim data As CellData = TryCast(item, CellData)
    Return If(CanApplyCustomTemplate(data.Cell.GetReferenceA1()), GetCellTemplate(data.Cell, CType(container, SpreadsheetControl)), MyBase.SelectTemplate(item, container))
End Function

wpf-spreadsheet-how-to-perform-a-mail-merge-t618180/VB/WpfSpreadsheetMailMerge/MainWindow.xaml.vb#L22

Get
    Return spreadsheetControl.Document
End Get

wpf-spreadsheet-how-to-replace-standard-command-with-custom-command/VB/WpfSpreadsheet_CustomCommand/CustomCommandService.vb#L16

End Sub
Public Property Control() As SpreadsheetControl

Inheritance

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Control

SpreadsheetControl