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.v20.1.dll

Declaration

public object DocumentSource { get; set; }
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:

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:

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