Aspose::Email::Mapi::PidTagPropertyDescriptor Class Reference

Class contains property description information. More...

Inherits Aspose::Email::Mapi::PropertyDescriptor.

Public Member Functions

int32_t get_Id () const
 Gets 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. More...
 
int64_t get_Tag () const
 A 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. More...
 
 PidTagPropertyDescriptor (int32_t id, PropertyDataType type)
 Initializes a new instance of the PidTagPropertyDescriptor class A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 � 0x7FFF. Property IDs in the range 0x8000 � 0x8FFF are reserved for assignment to named properties More...
 
 PidTagPropertyDescriptor (System::String canonicalName, int32_t id, PropertyDataType type)
 Initializes a new instance of the PidTagPropertyDescriptor class A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 � 0x7FFF. Property IDs in the range 0x8000 � 0x8FFF are reserved for assignment to named properties More...
 
 PidTagPropertyDescriptor (System::String canonicalName, System::String name, int32_t id, PropertyDataType type)
 Initializes a new instance of the PidTagPropertyDescriptor class A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 � 0x7FFF. Property IDs in the range 0x8000 � 0x8FFF are reserved for assignment to named properties More...
 
 PidTagPropertyDescriptor (int64_t tag)
 Initializes a new instance of the PidTagPropertyDescriptor class A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 � 0x7FFF. Property IDs in the range 0x8000 � 0x8FFF are reserved for assignment to named properties More...
 
 PidTagPropertyDescriptor (System::String canonicalName, System::String name, int64_t tag)
 Initializes a new instance of the PidTagPropertyDescriptor class A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 � 0x7FFF. Property IDs in the range 0x8000 � 0x8FFF are reserved for assignment to named properties More...
 
bool Equals (System::SharedPtr< System::Object > other) override
 Determines whether the specified System.Object is equal to the current System.Object. More...
 
bool Equals (System::SharedPtr< PropertyDescriptor > other) override
 Indicates whether the current object is equal to another object of the same type. More...
 
int32_t GetHashCode () const override
 Serves as a hash function for a type. More...
 
System::String ToString () const override
 Returns a string that represents the property description. More...
 
- Public Member Functions inherited from Aspose::Email::Mapi::PropertyDescriptor
PropertyDataType get_DataType ()
 The property value type, as described in [MS-OXCDATA], that specifies the type of values allowed for the property. More...
 
bool get_MultipleValuesDataType ()
 Indicates if data type contains of multiple values More...
 
System::String get_CanonicalName () const
 The 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: More...
 
System::String get_Name () const
 Gets string that, identifies a property. More...
 
 PropertyDescriptor (PropertyDataType type)
 Initializes a new instance of the PropertyDescriptor class More...
 
 PropertyDescriptor (System::String canonicalName, PropertyDataType type)
 Initializes a new instance of the PropertyDescriptor class More...
 
 PropertyDescriptor (System::String canonicalName, System::String name, PropertyDataType type)
 Initializes a new instance of the PropertyDescriptor class More...
 
System::ArrayPtr< uint8_t > ToBytes (System::SharedPtr< System::Object > value)
 Converts value to binary data More...
 
System::ArrayPtr< uint8_t > ToBytes (System::SharedPtr< System::Object > value, System::SharedPtr< System::Globalization::DateTimeFormatInfo > dateTimeFormatInfo)
 Converts value to binary data More...
 

Static Public Member Functions

static System::SharedPtr< PidTagPropertyDescriptorto_PidTagPropertyDescriptor (int64_t tag)
 
- Static Public Member Functions inherited from Aspose::Email::Mapi::PropertyDescriptor
static bool get_Use8BitStringAsUnicode ()
 Specifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String More...
 
static void set_Use8BitStringAsUnicode (bool value)
 Specifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String More...
 
static System::SharedPtr< PropertyDescriptorParse (System::String data)
 Initializes a new instance of the PropertyDescriptor class More...
 
static System::SharedPtr< PidTagPropertyDescriptorGetInstance (int32_t id, PropertyDataType dataType)
 Retrieves PidTagPropertyDescriptor object More...
 
static System::SharedPtr< PidTagPropertyDescriptorGetInstance (int64_t tag)
 Retrieves PidTagPropertyDescriptor object More...
 
static System::SharedPtr< PidLidPropertyDescriptorGetInstance (int64_t lid, PropertyDataType dataType, System::Guid propertySet)
 Retrieves PidLidPropertyDescriptor object More...
 
static System::SharedPtr< PidNamePropertyDescriptorGetInstance (System::String name, PropertyDataType dataType, System::Guid propertySet)
 Retrieves PidNamePropertyDescriptor object More...
 
static System::SharedPtr< PropertyDescriptorGetInstance (System::SharedPtr< MapiProperty > property)
 Retrieves PropertyDescriptor object from MAPI property More...
 
static void ThrowUnsupportedType (System::SharedPtr< System::Object > value)
 
static System::ArrayPtr< uint8_t > ToBytes (System::SharedPtr< PropertyDescriptor > pd, System::SharedPtr< System::Object > value, System::SharedPtr< System::Globalization::DateTimeFormatInfo > dateTimeFormatInfo)
 Converts value to binary data More...
 
static System::ArrayPtr< uint8_t > ToBytes (System::SharedPtr< PropertyDescriptor > pd, System::SharedPtr< System::Object > value)
 Converts value to binary data More...
 

Friends

bool operator== (System::SharedPtr< PidTagPropertyDescriptor > pd1, System::SharedPtr< PropertyDescriptor > pd2)
 
bool operator!= (System::SharedPtr< PidTagPropertyDescriptor > pd1, System::SharedPtr< PropertyDescriptor > pd2)
 

Additional Inherited Members

- Protected Member Functions inherited from Aspose::Email::Mapi::PropertyDescriptor
virtual ~PropertyDescriptor ()
 

Detailed Description

Class contains property description information.

Constructor & Destructor Documentation

◆ PidTagPropertyDescriptor() [1/5]

Aspose::Email::Mapi::PidTagPropertyDescriptor::PidTagPropertyDescriptor ( int32_t  id,
PropertyDataType  type 
)

Initializes a new instance of the PidTagPropertyDescriptor class A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 � 0x7FFF. Property IDs in the range 0x8000 � 0x8FFF are reserved for assignment to named properties

Parameters
idUnsigned 16-bit quantity that identifies a tagged property.
typeSpecifies the type of values allowed for the property.

◆ PidTagPropertyDescriptor() [2/5]

Aspose::Email::Mapi::PidTagPropertyDescriptor::PidTagPropertyDescriptor ( System::String  canonicalName,
int32_t  id,
PropertyDataType  type 
)

Initializes a new instance of the PidTagPropertyDescriptor class A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 � 0x7FFF. Property IDs in the range 0x8000 � 0x8FFF are reserved for assignment to named properties

Parameters
canonicalNameThe name used to refer to the property in the documentation.
idUnsigned 16-bit quantity that identifies a tagged property.
typeSpecifies the type of values allowed for the property.

◆ PidTagPropertyDescriptor() [3/5]

Aspose::Email::Mapi::PidTagPropertyDescriptor::PidTagPropertyDescriptor ( System::String  canonicalName,
System::String  name,
int32_t  id,
PropertyDataType  type 
)

Initializes a new instance of the PidTagPropertyDescriptor class A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 � 0x7FFF. Property IDs in the range 0x8000 � 0x8FFF are reserved for assignment to named properties

Parameters
canonicalNameThe name used to refer to the property in the documentation.
nameThe MAPI name used to refer to the property in the documentation.
idUnsigned 16-bit quantity that identifies a tagged property.
typeSpecifies the type of values allowed for the property.

◆ PidTagPropertyDescriptor() [4/5]

Aspose::Email::Mapi::PidTagPropertyDescriptor::PidTagPropertyDescriptor ( int64_t  tag)

Initializes a new instance of the PidTagPropertyDescriptor class A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 � 0x7FFF. Property IDs in the range 0x8000 � 0x8FFF are reserved for assignment to named properties

Parameters
tagA 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

◆ PidTagPropertyDescriptor() [5/5]

Aspose::Email::Mapi::PidTagPropertyDescriptor::PidTagPropertyDescriptor ( System::String  canonicalName,
System::String  name,
int64_t  tag 
)

Initializes a new instance of the PidTagPropertyDescriptor class A property that is defined by a 16-bit property ID and a 16-bit property type. The property ID for a tagged property is in the range 0x001 � 0x7FFF. Property IDs in the range 0x8000 � 0x8FFF are reserved for assignment to named properties

Parameters
canonicalNameThe name used to refer to the property in the documentation.
nameThe MAPI name used to refer to the property in the documentation.
tagA 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

Member Function Documentation

◆ Equals() [1/2]

bool Aspose::Email::Mapi::PidTagPropertyDescriptor::Equals ( System::SharedPtr< PropertyDescriptor other)
overridevirtual

Indicates whether the current object is equal to another object of the same type.

Parameters
otherAn object to compare with this object.
Returns
true if the current object is equal to the other parameter; otherwise, false.

Implements Aspose::Email::Mapi::PropertyDescriptor.

◆ Equals() [2/2]

bool Aspose::Email::Mapi::PidTagPropertyDescriptor::Equals ( System::SharedPtr< System::Object >  other)
override

Determines whether the specified System.Object is equal to the current System.Object.

Parameters
objThe object to compare with the current object.
Returns
true if the specified System.Object is equal to the current System.Object; otherwise, false.

◆ get_Id()

int32_t Aspose::Email::Mapi::PidTagPropertyDescriptor::get_Id ( ) const

Gets 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.

◆ get_Tag()

int64_t Aspose::Email::Mapi::PidTagPropertyDescriptor::get_Tag ( ) const

A 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.

◆ GetHashCode()

int32_t Aspose::Email::Mapi::PidTagPropertyDescriptor::GetHashCode ( ) const
override

Serves as a hash function for a type.

Returns
A hash code for the current object.

◆ to_PidTagPropertyDescriptor()

static System::SharedPtr<PidTagPropertyDescriptor> Aspose::Email::Mapi::PidTagPropertyDescriptor::to_PidTagPropertyDescriptor ( int64_t  tag)
static

◆ ToString()

System::String Aspose::Email::Mapi::PidTagPropertyDescriptor::ToString ( ) const
override

Returns a string that represents the property description.

Returns
A string that represents the property description.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( System::SharedPtr< PidTagPropertyDescriptor pd1,
System::SharedPtr< PropertyDescriptor pd2 
)
friend

◆ operator==

bool operator== ( System::SharedPtr< PidTagPropertyDescriptor pd1,
System::SharedPtr< PropertyDescriptor pd2 
)
friend