TX Text Control .NET Server

UserDefinedDocumentProperties Property

Property|Introduced in 24.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.Core.SDK as TXTextControl.Core.dll from the private NuGet feed or Text Control Offline Packages
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.dll

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; }

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}");

Limitations

Read only.

Further Reading

  • Maintaining Custom Document Properties –
  • Using Custom Document Properties to Store Additional Document Information –