Class contains property description information. More...

Inherits IEquatable< System::SharedPtr< Aspose::Email::Mapi::PropertyDescriptor > >.

Inherited by Aspose::Email::Mapi::PidLidPropertyDescriptor, Aspose::Email::Mapi::PidNamePropertyDescriptor, and Aspose::Email::Mapi::PidTagPropertyDescriptor.

Public Member Functions
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...

bool	Equals (System::SharedPtr< PropertyDescriptor > other) override=0
	Indicates whether the current object is equal to another object of the same type. 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 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< PropertyDescriptor >	Parse (System::String data)
	Initializes a new instance of the PropertyDescriptor class More...

static System::SharedPtr< PidTagPropertyDescriptor >	GetInstance (int32_t id, PropertyDataType dataType)
	Retrieves PidTagPropertyDescriptor object More...

static System::SharedPtr< PidTagPropertyDescriptor >	GetInstance (int64_t tag)
	Retrieves PidTagPropertyDescriptor object More...

static System::SharedPtr< PidLidPropertyDescriptor >	GetInstance (int64_t lid, PropertyDataType dataType, System::Guid propertySet)
	Retrieves PidLidPropertyDescriptor object More...

static System::SharedPtr< PidNamePropertyDescriptor >	GetInstance (System::String name, PropertyDataType dataType, System::Guid propertySet)
	Retrieves PidNamePropertyDescriptor object More...

static System::SharedPtr< PropertyDescriptor >	GetInstance (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...

Protected Member Functions
virtual	~PropertyDescriptor ()

Friends
class	Aspose::Email::Mapi::MapiAttachment

class	Aspose::Email::Mapi::MapiMessageItemBase

class	Aspose::Email::Mapi::MapiNamedProperty

class	Aspose::Email::Mapi::MapiProperty

class	Aspose::Email::Mapi::MapiPropertyCollection

class	Aspose::Email::Mapi::PidLidPropertyDescriptor

class	Aspose::Email::Mapi::PidNamePropertyDescriptor

class	Aspose::Email::Mapi::PidTagPropertyDescriptor

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

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

Detailed Description

Class contains property description information.

Constructor & Destructor Documentation

◆ PropertyDescriptor() [1/3]

Aspose::Email::Mapi::PropertyDescriptor::PropertyDescriptor ( PropertyDataType type )

Initializes a new instance of the PropertyDescriptor class

Parameters

type	The property value type, as described in [MS-OXCDATA], that specifies the type of values allowed for the property.

◆ PropertyDescriptor() [2/3]

Aspose::Email::Mapi::PropertyDescriptor::PropertyDescriptor	(	System::String	canonicalName,
		PropertyDataType	type
	)

Initializes a new instance of the PropertyDescriptor class

Parameters

canonicalName	The name used to refer to the property in the documentation.
type	The property value type, as described in [MS-OXCDATA], that specifies the type of values allowed for the property.

◆ PropertyDescriptor() [3/3]

Aspose::Email::Mapi::PropertyDescriptor::PropertyDescriptor	(	System::String	canonicalName,
		System::String	name,
		PropertyDataType	type
	)

Initializes a new instance of the PropertyDescriptor class

Parameters

canonicalName	The name used to refer to the property in the documentation.
name	The MAPI name used to refer to the property in the documentation.
type	The property value type, as described in [MS-OXCDATA], that specifies the type of values allowed for the property.

◆ ~PropertyDescriptor()

virtual Aspose::Email::Mapi::PropertyDescriptor::~PropertyDescriptor ( )

protectedvirtual

Member Function Documentation

◆ Equals()

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

overridepure virtual

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

Parameters

other An object to compare with this object.

Returns: true if the current object is equal to the other parameter; otherwise, false.

Implemented in Aspose::Email::Mapi::PidTagPropertyDescriptor, Aspose::Email::Mapi::PidNamePropertyDescriptor, and Aspose::Email::Mapi::PidLidPropertyDescriptor.

◆ get_CanonicalName()

System::String Aspose::Email::Mapi::PropertyDescriptor::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:

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.

◆ get_DataType()

PropertyDataType Aspose::Email::Mapi::PropertyDescriptor::get_DataType ( )

The property value type, as described in [MS-OXCDATA], that specifies the type of values allowed for the property.

◆ get_MultipleValuesDataType()

bool Aspose::Email::Mapi::PropertyDescriptor::get_MultipleValuesDataType ( )

Indicates if data type contains of multiple values

◆ get_Name()

System::String Aspose::Email::Mapi::PropertyDescriptor::get_Name ( ) const

Gets string that, identifies a property.

◆ get_Use8BitStringAsUnicode()

static bool Aspose::Email::Mapi::PropertyDescriptor::get_Use8BitStringAsUnicode ( )

static

Specifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String

◆ GetInstance() [1/5]

static System::SharedPtr<PidTagPropertyDescriptor> Aspose::Email::Mapi::PropertyDescriptor::GetInstance	(	int32_t	id,
		PropertyDataType	dataType
	)

static

Retrieves PidTagPropertyDescriptor object

Parameters

id	Id of a property
dataType	Data type of a property

Returns: PidTagPropertyDescriptor object

◆ GetInstance() [2/5]

static System::SharedPtr<PidLidPropertyDescriptor> Aspose::Email::Mapi::PropertyDescriptor::GetInstance	(	int64_t	lid,
		PropertyDataType	dataType,
		System::Guid	propertySet
	)

static

Retrieves PidLidPropertyDescriptor object

Parameters

lid	Long id of a property
dataType	Data type of a property
propertySet	PropertySet of a property

Returns: PidLidPropertyDescriptor object

◆ GetInstance() [3/5]

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

static

Retrieves PidTagPropertyDescriptor object

Parameters

tag	Tag of a property

Returns: PidTagPropertyDescriptor object

◆ GetInstance() [4/5]

static System::SharedPtr<PropertyDescriptor> Aspose::Email::Mapi::PropertyDescriptor::GetInstance ( System::SharedPtr< MapiProperty > property )

static

Retrieves PropertyDescriptor object from MAPI property

Parameters

property MapiProperty object

◆ GetInstance() [5/5]

static System::SharedPtr<PidNamePropertyDescriptor> Aspose::Email::Mapi::PropertyDescriptor::GetInstance	(	System::String	name,
		PropertyDataType	dataType,
		System::Guid	propertySet
	)

static

Retrieves PidNamePropertyDescriptor object

Parameters

name	Name of a property
dataType	Data type of a property
propertySet	PropertySet of a property

Returns: PidNamePropertyDescriptor object

◆ Parse()

static System::SharedPtr<PropertyDescriptor> Aspose::Email::Mapi::PropertyDescriptor::Parse ( System::String data )

static

Initializes a new instance of the PropertyDescriptor class

Parameters

data	A string that represents the property description.

◆ set_Use8BitStringAsUnicode()

static void Aspose::Email::Mapi::PropertyDescriptor::set_Use8BitStringAsUnicode ( bool value )

static

Specifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String

◆ ThrowUnsupportedType()

static void Aspose::Email::Mapi::PropertyDescriptor::ThrowUnsupportedType ( System::SharedPtr< System::Object > value )

static

◆ ToBytes() [1/4]

static System::ArrayPtr<uint8_t> Aspose::Email::Mapi::PropertyDescriptor::ToBytes	(	System::SharedPtr< PropertyDescriptor >	pd,
		System::SharedPtr< System::Object >	value
	)

static

Converts value to binary data

Parameters

pd	The property descriptor.
value	The property data.

◆ ToBytes() [2/4]

static System::ArrayPtr<uint8_t> Aspose::Email::Mapi::PropertyDescriptor::ToBytes	(	System::SharedPtr< PropertyDescriptor >	pd,
		System::SharedPtr< System::Object >	value,
		System::SharedPtr< System::Globalization::DateTimeFormatInfo >	dateTimeFormatInfo
	)

static

Converts value to binary data

Parameters

pd	The property descriptor.
value	The property data.
dateTimeFormatInfo	DateTime format provider.

◆ ToBytes() [3/4]

System::ArrayPtr<uint8_t> Aspose::Email::Mapi::PropertyDescriptor::ToBytes ( System::SharedPtr< System::Object > value )

Converts value to binary data

Parameters

value The property data.

◆ ToBytes() [4/4]

System::ArrayPtr<uint8_t> Aspose::Email::Mapi::PropertyDescriptor::ToBytes	(	System::SharedPtr< System::Object >	value,
		System::SharedPtr< System::Globalization::DateTimeFormatInfo >	dateTimeFormatInfo
	)

Converts value to binary data

Parameters

value	The property data.
dateTimeFormatInfo	DateTime format provider.

Friends And Related Function Documentation

◆ Aspose::Email::Mapi::MapiAttachment

friend class Aspose::Email::Mapi::MapiAttachment

friend

◆ Aspose::Email::Mapi::MapiMessageItemBase

friend class Aspose::Email::Mapi::MapiMessageItemBase

friend

◆ Aspose::Email::Mapi::MapiNamedProperty

friend class Aspose::Email::Mapi::MapiNamedProperty

friend

◆ Aspose::Email::Mapi::MapiProperty

friend class Aspose::Email::Mapi::MapiProperty

friend

◆ Aspose::Email::Mapi::MapiPropertyCollection

friend class Aspose::Email::Mapi::MapiPropertyCollection

friend

◆ Aspose::Email::Mapi::PidLidPropertyDescriptor

friend class Aspose::Email::Mapi::PidLidPropertyDescriptor

friend

◆ Aspose::Email::Mapi::PidNamePropertyDescriptor

friend class Aspose::Email::Mapi::PidNamePropertyDescriptor

friend

◆ Aspose::Email::Mapi::PidTagPropertyDescriptor

friend class Aspose::Email::Mapi::PidTagPropertyDescriptor

friend

◆ operator!=

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

friend

◆ operator==

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

friend

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PropertyDescriptor() [1/3]

◆ PropertyDescriptor() [2/3]

◆ PropertyDescriptor() [3/3]

◆ ~PropertyDescriptor()

Member Function Documentation

◆ Equals()

◆ get_CanonicalName()

◆ get_DataType()

◆ get_MultipleValuesDataType()

◆ get_Name()

◆ get_Use8BitStringAsUnicode()

◆ GetInstance() [1/5]

◆ GetInstance() [2/5]

◆ GetInstance() [3/5]

◆ GetInstance() [4/5]

◆ GetInstance() [5/5]

◆ Parse()

◆ set_Use8BitStringAsUnicode()

◆ ThrowUnsupportedType()

◆ ToBytes() [1/4]

◆ ToBytes() [2/4]

◆ ToBytes() [3/4]

◆ ToBytes() [4/4]

Friends And Related Function Documentation

◆ Aspose::Email::Mapi::MapiAttachment

◆ Aspose::Email::Mapi::MapiMessageItemBase

◆ Aspose::Email::Mapi::MapiNamedProperty

◆ Aspose::Email::Mapi::MapiProperty

◆ Aspose::Email::Mapi::MapiPropertyCollection

◆ Aspose::Email::Mapi::PidLidPropertyDescriptor

◆ Aspose::Email::Mapi::PidNamePropertyDescriptor

◆ Aspose::Email::Mapi::PidTagPropertyDescriptor

◆ operator!=

◆ operator==