SpreadsheetControl.LoadDocument(String, DocumentFormat) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Loads a document from a file, specifying the document format.

Namespace: DevExpress.Xpf.Spreadsheet

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

NuGet Package: DevExpress.Wpf.Spreadsheet

Declaration

C#

public bool LoadDocument(
    string fileName,
    DocumentFormat format
)

VB.NET

Public Function LoadDocument(
    fileName As String,
    format As DocumentFormat
) As Boolean

Parameters

Name	Type	Description
fileName	String	A string value specifying the path to a file from which to load a document.
format	DocumentFormat	The DocumentFormat enumeration member.

Returns

Type	Description
Boolean	true, if a document is loaded successfully; otherwise, false.

Remarks

If the data has an incorrect format, the SpreadsheetControl.InvalidFormatException event fires.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LoadDocument(String, DocumentFormat) method.

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-spreadsheet-bind-grid-control-to-worksheet-data/CS/WpfSpreadsheet_DataBinding/MainWindow.xaml.cs#L17

    spreadsheet.Options.Culture = new CultureInfo("en-US");
    spreadsheet.LoadDocument(@"Documents/Expenses_template.xlsx", DocumentFormat.Xlsx);
}

VB.NET

wpf-spreadsheet-bind-grid-control-to-worksheet-data/VB/WpfSpreadsheet_DataBinding/MainWindow.xaml.vb#L16

    spreadsheet.Options.Culture = New CultureInfo("en-US")
    spreadsheet.LoadDocument("Documents/Expenses_template.xlsx", DocumentFormat.Xlsx)
End Sub