TXTextControl.UserDefinedPropertyDictionary Class

An instance of the UserDefinedPropertyDictionary class contains all user-defined document properties contained in a loaded document or which will be saved in a document. The UserDefinedPropertyDictionary class is used with the LoadSettings.UserDefinedDocumentProperties and SaveSettings.UserDefinedDocumentProperties properties. Each entry in the dictionary is a key/value pair, where the key is the name of the document property and the value is the document property's value. The foreach statement of the C# language (for each in Visual Basic) returns an object of the type of the elements in the collection. Since each element is a key/value pair, the element type is System.Collections.DictionaryEntry. The name must be of the type System.String and is limited to 255 characters. The value can be of the type System.String, System.Boolean, System.Int32 or System.Double.

Introduced: 24.0.

Syntax

[C#]
public class UserDefinedPropertyDictionary : System.Collections.DictionaryBase
[Visual Basic]
Public Class UserDefinedPropertyDictionary : System.Collections.DictionaryBase

Constructors

Constructor Description
UserDefinedPropertyDictionary Initializes a new instance of the UserDefinedPropertyDictionary class.

Properties

Property Description
Names Gets a collection of all property names the dictionary contains.
Values Gets a collection of all property values the dictionary contains.

Methods

Method Description
Add Adds a new property to the dictionary.
Contains Determines whether the dictionary contains a property with the specified name.
Item Gets a document property from the dictionary.
Remove Removes a document property from the dictionary.

See Also