Skip to main content

SpreadsheetControl.LoadDocument(Stream) Method

Loads a document from a stream.

Namespace: DevExpress.Xpf.Spreadsheet

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

NuGet Package: DevExpress.Wpf.Spreadsheet

Declaration

public bool LoadDocument(
    Stream stream
)

Parameters

Name Type Description
stream Stream

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

Returns

Type Description
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