UserDefinedPropertyDictionary Class

Description

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.

Syntax

public class UserDefinedPropertyDictionary : DictionaryBase

Public Class UserDefinedPropertyDictionary
    Inherits DictionaryBase

Examples

The following example creates a property dictionary and assigns it to the document settings.

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

Dim properties As New UserDefinedPropertyDictionary()
properties.Add("ReviewStatus", "Approved")
properties.Add("Department", "Finance")
textControl.DocumentSettings.UserDefinedDocumentProperties = properties

Members

Constructors

Properties

Methods