Workbook.LoadDocumentProperties(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 document properties from the specified workbook.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

csharp

public ReadOnlyDocumentProperties LoadDocumentProperties(
    string fileName,
    DocumentFormat format
)

Public Function LoadDocumentProperties(
    fileName As String,
    format As DocumentFormat
) As ReadOnlyDocumentProperties

Parameters

Name	Type	Description
fileName	String

The path to the target file.

| | format | DocumentFormat |

An enumeration member that defines the document format.

Returns

Type	Description
ReadOnlyDocumentProperties

An object that stores the retrieved document properties.

Remarks

Use this method to load document metadata (document properties) without loading the workbook itself. You can use the retrieved metadata to search for a specific document, to organize files, or to collect statistics.

The Spreadsheet Document API can load document properties from workbooks in the following formats:

XLSX,
XLSM,
XLSB,
XLS,
XLTX,
XLTM,
XLT,
XML (XML Spreadsheet 2003).

For CSV and TXT files or encrypted documents, the LoadDocumentProperties method returns empty properties. If the loaded document is corrupted or its format is unknown, the LoadDocumentProperties method throws an exception.