Back to Devexpress

SpreadsheetControl.LoadDocument(Stream) Method

wpf-devexpress-dot-xpf-dot-spreadsheet-dot-spreadsheetcontrol-dot-loaddocument-x28-system-dot-io-dot-stream-x29.md

latest2.2 KB
Original Source

SpreadsheetControl.LoadDocument(Stream) Method

Loads a document from a stream.

Namespace : DevExpress.Xpf.Spreadsheet

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

NuGet Package : DevExpress.Wpf.Spreadsheet

Declaration

csharp
public bool LoadDocument(
    Stream stream
)
vb
Public Function LoadDocument(
    stream As Stream
) As Boolean

Parameters

NameTypeDescription
streamStream

A Stream objects that is the stream used to load a document.

|

Returns

TypeDescription
Boolean

true, if the document is loaded successfully; otherwise, false.

|

Remarks

The target stream can use a non-seekable stream to load a document. In this case, the stream buffers automatically.

The format of the document loaded from a stream is detected automatically by the built-in IFormatDetectorService service implementation. The following formats can be detected:

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

If the format detection fails, an ISpreadsheetComponent.InvalidFormatException is raised.

See Also

SpreadsheetControl Class

SpreadsheetControl Members

DevExpress.Xpf.Spreadsheet Namespace