Skip to main content
All docs
V24.1

RichEditDocumentServerExtensions.LoadDocumentProperties(RichEditDocumentServer, String, DocumentFormat) Method

Loads metadata (document properties) of a document in the specified format from the specified file.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

public static ReadOnlyDocumentProperties LoadDocumentProperties(
    this RichEditDocumentServer self,
    string fileName,
    DocumentFormat documentFormat
)

Parameters

Name Type Description
self RichEditDocumentServer

The current RichEditDocumentServer instance.

fileName String

A path to the document which metadata should be loaded.

documentFormat DocumentFormat

The document format.

Returns

Type Description
ReadOnlyDocumentProperties

A collection of document properties.

Remarks

Important

The RichEditDocumentServerExtensions class is defined in the DevExpress.Docs.v24.1.dll assembly. Add this assembly to your project to use the RichEditDocumentServerExtensions members. You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this library in production code.

Use this method to load document properties without loading the document itself. Refer to the following help topic for a list of supported document properties in different formats: How to: Specify Document Properties.

Note

The RichEditDocumentServer loads the document properties of the WordML and RTF files only if the metadata is located before the document body.

The code sample below loads the document properties and sorts files by their modification date:

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
using System;
using System.IO;
using System.Diagnostics;

static void Main(string[] args)
{
    DirectoryInfo directoryInfo = 
    new DirectoryInfo(@"C:\Users\Public\Documents\DevExpress Demos 24.1\Components\Data");
    FileInfo[] files = directoryInfo.GetFiles("*.docx");
    foreach (FileInfo file in files)
    {
        SortDocuments(file.FullName, file.Name);
    }
    Process.Start("explorer.exe", @"C:\Documents");
}

public static void SortDocuments(string filePath, string fileName)
{
    RichEditDocumentServer wordProcessor = new RichEditDocumentServer();

    //Load the metadata from the specified document:
    ReadOnlyDocumentProperties docProperties = 
    wordProcessor.LoadDocumentProperties(filePath, DocumentFormat.OpenXml);
    DateTime date = docProperties.BuiltIn.Modified;

    //Check the year the document was last modified,
    //And copy the file to the corresponding folder:
    switch (date.Year)
    {
        case 2017:
            File.Copy(filePath, string.Format("C://Documents//2017//{0}", fileName), true);
            break;
        case 2018:
            File.Copy(filePath, string.Format("C://Documents//2018//{0}", fileName), true);
            break;
        case 2019:
            File.Copy(filePath, string.Format("C://Documents//2019//{0}", fileName), true);
            break;
        case 2020:
            File.Copy(filePath, string.Format("C://Documents//2020//{0}", fileName), true);
            break;
    }
}
See Also