officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-document-7237d901.md
Provides access to a collection of the document’s custom properties.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
DocumentCustomProperties CustomProperties { get; }
ReadOnly Property CustomProperties As DocumentCustomProperties
| Type | Description |
|---|---|
| DocumentCustomProperties |
A DocumentCustomProperties object that stores document’s custom properties.
|
server.CreateNewDocument();
Document document = server.Document;
document.BeginUpdate();
document.Fields.Create(document.AppendText("\nMyNumericProperty: ").End, "DOCVARIABLE CustomProperty MyNumericProperty");
document.Fields.Create(document.AppendText("\nMyStringProperty: ").End, "DOCVARIABLE CustomProperty MyStringProperty");
document.Fields.Create(document.AppendText("\nMyBooleanProperty: ").End, "DOCVARIABLE CustomProperty MyBooleanProperty");
document.EndUpdate();
document.CustomProperties["MyNumericProperty"]= 123.45;
document.CustomProperties["MyStringProperty"]="The Final Answer";
document.CustomProperties["MyBooleanProperty"]=true;
server.CalculateDocumentVariable += DocumentPropertyDisplayHelper.OnCalculateDocumentVariable;
document.Fields.Update();
server.CreateNewDocument()
Dim document As Document = server.Document
document.BeginUpdate()
document.Fields.Create(document.AppendText(vbLf & "MyNumericProperty: ").End, "DOCVARIABLE CustomProperty MyNumericProperty")
document.Fields.Create(document.AppendText(vbLf & "MyStringProperty: ").End, "DOCVARIABLE CustomProperty MyStringProperty")
document.Fields.Create(document.AppendText(vbLf & "MyBooleanProperty: ").End, "DOCVARIABLE CustomProperty MyBooleanProperty")
document.EndUpdate()
document.CustomProperties("MyNumericProperty")= 123.45
document.CustomProperties("MyStringProperty")="The Final Answer"
document.CustomProperties("MyBooleanProperty")=True
AddHandler server.CalculateDocumentVariable, AddressOf DocumentPropertyDisplayHelper.OnCalculateDocumentVariable
document.Fields.Update()
The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomProperties property.
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.
document.CustomProperties["MyNumericProperty"] = 123.45;
document.CustomProperties["MyStringProperty"] = "The Final Answer";
winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/DocumentProperties.cs#L47
document.CustomProperties["MyNumericProperty"]= 123.45;
document.CustomProperties["MyStringProperty"]="The Final Answer";
word-document-api-examples/CS/CodeExamples/DocumentPropertiesActions.cs#L63
// Set the custom document properties.
document.CustomProperties["MyNumericProperty"] = 123.45;
document.CustomProperties["MyStringProperty"] = "The Final Answer";
document.CustomProperties("MyNumericProperty") = 123.45
document.CustomProperties("MyStringProperty") = "The Final Answer"
winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/DocumentProperties.vb#L43
document.EndUpdate()
document.CustomProperties("MyNumericProperty") = 123.45
document.CustomProperties("MyStringProperty") = "The Final Answer"
word-document-api-examples/VB/CodeExamples/DocumentPropertiesActions.vb#L53
' Set the custom document properties.
document.CustomProperties("MyNumericProperty") = 123.45
document.CustomProperties("MyStringProperty") = "The Final Answer"
See Also