DocumentSettings.UserDefinedDocumentProperties Property

UserDefinedDocumentProperties Property

Property|Introduced in 29.0

Namespace: TXTextControl

Package: TXTextControl.TextControl.WPF.SDK as TXTextControl.dll from the private NuGet feed or Text Control Offline Packages

Description

Gets or sets a dictionary with all user-defined document properties contained in the current document. The property's value is an object of the type UserDefinedPropertyDictionary or null, if the current document does not contain any user-defined property.

Syntax

public UserDefinedPropertyDictionary UserDefinedDocumentProperties { get; set; }

Public Property UserDefinedDocumentProperties As UserDefinedPropertyDictionary

Examples

The following example attaches review metadata as user-defined document properties.

UserDefinedPropertyDictionary properties = new();
properties.Add("ReviewStatus", "Approved");
properties.Add("Department", "Finance");

DocumentSettings documentSettings = textControl.DocumentSettings;
documentSettings.UserDefinedDocumentProperties = properties;

Dim properties As New UserDefinedPropertyDictionary()
properties.Add("ReviewStatus", "Approved")
properties.Add("Department", "Finance")

Dim documentSettings As DocumentSettings = textControl.DocumentSettings
documentSettings.UserDefinedDocumentProperties = properties