LoadSettings.UserDefinedDocumentProperties Property

UserDefinedDocumentProperties Property

Property|Introduced in 24.0

Namespace: TXTextControl

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

Description

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

Syntax

public UserDefinedPropertyDictionary UserDefinedDocumentProperties { get; }

Public ReadOnly Property UserDefinedDocumentProperties As UserDefinedPropertyDictionary

Examples

The following example reads LoadSettings.UserDefinedDocumentProperties after the template has been loaded.

LoadSettings loadSettings = new();
textControl.Load("template.docx", StreamType.WordprocessingML, loadSettings);
Console.WriteLine($"User Defined Document Properties: {loadSettings.UserDefinedDocumentProperties}");

Dim loadSettings As New LoadSettings()
textControl.Load("template.docx", StreamType.WordprocessingML, loadSettings)
Console.WriteLine($"User Defined Document Properties: {loadSettings.UserDefinedDocumentProperties}")

Limitations

Read only.