.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

DocumentProperties Interface

Contains core properties of the document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.2.Core.dll

Declaration

public interface DocumentProperties
Public Interface DocumentProperties
public interface DocumentProperties
Public Interface DocumentProperties
public interface DocumentProperties
Public Interface DocumentProperties

Remarks

Core Document Properties are implemented as described in Standard ECMA-376, 1st edition (December 2006) Office Open XML File Formats Part 2 - Open Packaging Conventions clause 10 "Core Properties".

Use the Document.DocumentProperties property to obtain the DocumentProperties object.

To get an individual document property, access it by name. To display a property in a document, insert an appropriate field.

This code snippet demonstrates how to set standard document properties and show them in a document using specific fields. The FieldCollection.Update method updates all property fields in the document body.

Note

If the DOCPROPERTY fields are located in the text box, header or footer, they should be updated separately. Use the Section.BeginUpdateHeader - Section.EndUpdateHeader or Section.BeginUpdateFooter - Section.EndUpdateFooter paired methods to obtain the header or footer. The TextBox.Document property allows you to retrieve the text box content and update the corresponding fields.

server.CreateNewDocument();
Document document = server.Document;
document.BeginUpdate();

document.DocumentProperties.Creator = "John Doe";
document.DocumentProperties.Title = "Inserting Custom Properties";
document.DocumentProperties.Category = "TestDoc";
document.DocumentProperties.Description = "This code demonstrates API to modify and display standard document properties.";

document.Fields.Create(document.AppendText("\nAUTHOR: ").End, "AUTHOR");
document.Fields.Create(document.AppendText("\nTITLE: ").End, "TITLE");
document.Fields.Create(document.AppendText("\nCOMMENTS: ").End, "COMMENTS");
document.Fields.Create(document.AppendText("\nCREATEDATE: ").End, "CREATEDATE");
document.Fields.Create(document.AppendText("\nCategory: ").End, "DOCPROPERTY Category");
document.Fields.Update();
document.EndUpdate();

Built-in Properties in Different Formats

The table below highlights what built-in document properties supported in different formats.

DOCX RTF DOC WordML ODT HTML
Category yes yes yes yes no no
ContentStatus yes no yes no no no
ContentType yes no no no no no
Created yes yes yes yes yes no
Creator yes yes yes yes yes no
Description yes yes yes yes yes no
Identifier yes no no no no no
Keywords yes yes yes yes yes no
Language yes no yes no no no
LastModifiedBy yes yes yes yes yes no
LastPrinted yes yes yes yes yes no
Modified yes yes yes yes yes no
Revision yes yes yes yes yes no
Subject yes yes yes yes yes no
Title yes yes yes yes yes yes
Version yes no yes no no no
See Also