UserDefinedDocumentProperties Property

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

• C#
• VB.NET

​public UserDefinedPropertyDictionary UserDefinedDocumentProperties { get; }

​Public ReadOnly Property UserDefinedDocumentProperties() As UserDefinedPropertyDictionary

Examples

This example demonstrates an easy use of the 'TXTextControl.LoadSettings.UserDefinedDocumentProperties' property. Here, it is stored in a variable of the type 'TXTextControl.UserDefinedPropertyDictionary'.

• C#
• VB.NET

​TXTextControl.LoadSettings ls = new TXTextControl.LoadSettings();
TXTextControl.UserDefinedPropertyDictionary myDefinedDocProperties = ls.UserDefinedDocumentProperties;

if (myDefinedDocProperties == null) {
    System.Windows.Forms.MessageBox.Show("This document does not contain any user-defined properties");
}

​Dim ls As TXTextControl.LoadSettings = New TXTextControl.LoadSettings()
Dim myDefinedDocProperties As TXTextControl.UserDefinedPropertyDictionary = ls.UserDefinedDocumentProperties

If myDefinedDocProperties Is Nothing Then
    System.Windows.Forms.MessageBox.Show("This document does not contain any user-defined properties")
End If

Further Reading

Learn more about the TXTextControl.LoadSettings.UserDefinedDocumentProperties Property in the Text Control Blog:

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