SpreadsheetControl.DocumentSource Property

Gets or sets a document supplier for a SpreadsheetControl. This is a dependency property.

Namespace: DevExpress.Xpf.Spreadsheet

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

NuGet Package: DevExpress.Wpf.Spreadsheet

Declaration

C#

public object DocumentSource { get; set; }

VB.NET

Public Property DocumentSource As Object

Property Value

Type	Description
Object	An object specifying the document to bind to the SpreadsheetControl.

Remarks

When the DocumentSource property is set, the SpreadsheetControl attempts to load a document specified by the property value.

You can use the following data sources:

• Stream (both seekable and non-seekable);
• String (recognized as the file path);
• Byte[] array;
• Uri;
• SpreadsheetDocumentSource instance.

The format of documents loaded from a Stream, Uri or Byte[] instance is detected automatically by the built-in IFormatDetectorService implementation.

The following formats can be detected on the fly:

• XLSX, XLSB, XLSM, XLTX, XLTM (non encrypted files only);
• XLS, XLT;
• XML Spreadsheet 2003;
• CSV, TXT (only if loaded from a FileStream instance).

If a SpreadsheetDocumentSource value is supplied, a document is loaded from the stream specified by the SpreadsheetDocumentSource.Stream property. The document format is determined by the SpreadsheetDocumentSource.Format property.

Tip

Set the DocumentSource property to null to create a new document.

The code sample below binds an XLSX file as the document source:

XAML

<Grid>
    <dxsps:SpreadsheetControl CommandBarStyle="Ribbon"
                              ShowFormulaBar="True"
                              DocumentSource="pack://application:,,,/WpfSpreadsheet;component/Document.xlsx"/>
</Grid>

Related GitHub Examples

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

XAML

wpf-spreadsheet-how-to-create-a-custom-message-box-service/CS/WpfSpreadsheet_MessageBoxService/MainWindow.xaml#L11

    <dxsps:SpreadsheetControl x:Name="spreadsheet" CommandBarStyle="Ribbon" ShowFormulaBar="True" Loaded="spreadsheet_Loaded"
                              DocumentSource="pack://application:,,,/WpfSpreadsheet_MessageBoxService;component/Document.xlsx"/>
</Grid>

wpf-spreadsheet-how-to-replace-standard-command-with-custom-command/CS/WpfSpreadsheet_CustomCommand/MainWindow.xaml#L10

    <dxsps:SpreadsheetControl x:Name="spreadsheetControl" CommandBarStyle="Ribbon" ShowFormulaBar="True" Loaded="spreadsheetControl_Loaded"
                              DocumentSource="pack://application:,,,/WpfSpreadsheet_CustomCommand;component/Document.xlsx"/>
</Grid>