PidTagPropertyDescriptor

PidTagPropertyDescriptor class

Class contains property description information.

The PidTagPropertyDescriptor type exposes the following members:

Constructors

NameDescription
PidTagPropertyDescriptor(id, type)Initializes a new instance of the PidTagPropertyDescriptor class
PidTagPropertyDescriptor(canonical_name, id, type)Initializes a new instance of the PidTagPropertyDescriptor class
PidTagPropertyDescriptor(canonical_name, name, id, type)Initializes a new instance of the PidTagPropertyDescriptor class
PidTagPropertyDescriptor(tag)Initializes a new instance of the PidTagPropertyDescriptor class
PidTagPropertyDescriptor(canonical_name, name, tag)Initializes a new instance of the PidTagPropertyDescriptor class

Properties

NameDescription
use_8_bit_string_as_unicodeSpecifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String
data_typeThe property value type, as described in [MS-OXCDATA], that specifies the type of values allowed for the property.
multiple_values_data_typeIndicates if data type contains of multiple values
canonical_nameThe name used to refer to the property in the documentation.
The prefix of the canonical name identifies the basic characteristics of a property to the implementer.
The canonical naming structure uses three categories that are denoted by the following prefixes to the canonical property name:
* PidLid prefix: Properties identified by an unsigned 32-bit quantity along with a property set.
* PidName prefix: Properties identified by a string name along with a property set.
* PidTag prefix: Properties identified by an unsigned 16-bit quantity.
nameGets string that, identifies a property.
idGets an unsigned 16-bit quantity that identifies a tagged property.
Property IDs are not necessarily unique.
With the exception of property IDs in the range from 0x6800 to 0x7BFF,
the combination of property ID and data type are unique.
Property IDs in the range from 0x6800 to 0x7BFF are defined by the message class.
tagA property tag is a 32-bit number that contains a unique property identifier in bits 16 through 31 and a property type in bits 0 through 15.

Methods

NameDescription
get_instance(id, data_type)
get_instance(tag)
get_instance(lid, data_type, property_set)
get_instance(name, data_type, property_set)
get_instance(property)
parse(data)
equals(other)

See Also