Aspose::Email::Mapi::PropertyDescriptor Class Referenceabstract

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

ASPOSE_EMAIL_SHARED_API PropertyDataType get_DataType ()
 The property value type, as described in [MS-OXCDATA], that specifies the type of values allowed for the property. More...
 
ASPOSE_EMAIL_SHARED_API bool get_MultipleValuesDataType ()
 Indicates if data type contains of multiple values More...
 
ASPOSE_EMAIL_SHARED_API 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...
 
ASPOSE_EMAIL_SHARED_API System::String get_Name () const
 Gets string that, identifies a property. More...
 
ASPOSE_EMAIL_SHARED_API PropertyDescriptor (PropertyDataType type)
 Initializes a new instance of the PropertyDescriptor class More...
 
ASPOSE_EMAIL_SHARED_API PropertyDescriptor (System::String canonicalName, PropertyDataType type)
 Initializes a new instance of the PropertyDescriptor class More...
 
ASPOSE_EMAIL_SHARED_API PropertyDescriptor (System::String canonicalName, System::String name, PropertyDataType type)
 Initializes a new instance of the PropertyDescriptor class More...
 
virtual ASPOSE_EMAIL_SHARED_API bool Equals (System::SharedPtr< PropertyDescriptor > other)=0
 Indicates whether the current object is equal to another object of the same type. More...
 
ASPOSE_EMAIL_SHARED_API System::ArrayPtr< uint8_t > ToBytes (System::SharedPtr< System::Object > value)
 Converts value to binary data More...
 
ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API bool get_Use8BitStringAsUnicode ()
 Specifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String More...
 
static ASPOSE_EMAIL_SHARED_API void set_Use8BitStringAsUnicode (bool value)
 Specifies if PropertyDataType.String8 has to be interpreted as PropertyDataType.String More...
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< PropertyDescriptorParse (System::String data)
 Initializes a new instance of the PropertyDescriptor class More...
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< PidTagPropertyDescriptorGetInstance (int32_t id, PropertyDataType dataType)
 Retrieves PidTagPropertyDescriptor object More...
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< PidTagPropertyDescriptorGetInstance (int64_t tag)
 Retrieves PidTagPropertyDescriptor object More...
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< PidLidPropertyDescriptorGetInstance (int64_t lid, PropertyDataType dataType, System::Guid propertySet)
 Retrieves PidLidPropertyDescriptor object More...
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< PidNamePropertyDescriptorGetInstance (System::String name, PropertyDataType dataType, System::Guid propertySet)
 Retrieves PidNamePropertyDescriptor object More...
 
static ASPOSE_EMAIL_SHARED_API System::SharedPtr< PropertyDescriptorGetInstance (System::SharedPtr< MapiProperty > property)
 Retrieves PropertyDescriptor object from MAPI property More...
 
static ASPOSE_EMAIL_SHARED_API void ThrowUnsupportedType (System::SharedPtr< System::Object > value)
 
static ASPOSE_EMAIL_SHARED_API 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 ASPOSE_EMAIL_SHARED_API System::ArrayPtr< uint8_t > ToBytes (System::SharedPtr< PropertyDescriptor > pd, System::SharedPtr< System::Object > value)
 Converts value to binary data More...
 

Protected Member Functions

virtual ASPOSE_EMAIL_SHARED_API ~PropertyDescriptor ()
 

Friends

class Aspose::Email::Mapi::PidLidPropertyDescriptor
 
class Aspose::Email::Mapi::PidNamePropertyDescriptor
 
class Aspose::Email::Mapi::PidTagPropertyDescriptor
 
class Aspose::Email::Mapi::MapiMessageItemBase
 
class Aspose::Email::Mapi::MapiAttachment
 
class Aspose::Email::Mapi::MapiNamedProperty
 
class Aspose::Email::Mapi::MapiProperty
 
class Aspose::Email::Mapi::MapiPropertyCollection
 
ASPOSE_EMAIL_SHARED_API bool operator== (System::SharedPtr< PropertyDescriptor > pd1, System::SharedPtr< PropertyDescriptor > pd2)
 
ASPOSE_EMAIL_SHARED_API 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_SHARED_API Aspose::Email::Mapi::PropertyDescriptor::PropertyDescriptor ( PropertyDataType  type)

Initializes a new instance of the PropertyDescriptor class

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

◆ PropertyDescriptor() [2/3]

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

Initializes a new instance of the PropertyDescriptor class

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

◆ PropertyDescriptor() [3/3]

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

Initializes a new instance of the PropertyDescriptor class

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

◆ ~PropertyDescriptor()

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

Member Function Documentation

◆ Equals()

virtual ASPOSE_EMAIL_SHARED_API bool Aspose::Email::Mapi::PropertyDescriptor::Equals ( System::SharedPtr< PropertyDescriptor other)
pure virtual

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.

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

◆ get_CanonicalName()

ASPOSE_EMAIL_SHARED_API 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()

ASPOSE_EMAIL_SHARED_API 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()

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

Indicates if data type contains of multiple values

◆ get_Name()

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

Gets string that, identifies a property.

◆ get_Use8BitStringAsUnicode()

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

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

◆ GetInstance() [1/5]

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

Retrieves PidTagPropertyDescriptor object

Parameters
idId of a property
dataTypeData type of a property
Returns
PidTagPropertyDescriptor object

◆ GetInstance() [2/5]

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

Retrieves PidLidPropertyDescriptor object

Parameters
lidLong id of a property
dataTypeData type of a property
propertySetPropertySet of a property
Returns
PidLidPropertyDescriptor object

◆ GetInstance() [3/5]

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

Retrieves PidTagPropertyDescriptor object

Parameters
tagTag of a property
Returns
PidTagPropertyDescriptor object

◆ GetInstance() [4/5]

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

Retrieves PropertyDescriptor object from MAPI property

Parameters
propertyMapiProperty object

◆ GetInstance() [5/5]

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

Retrieves PidNamePropertyDescriptor object

Parameters
nameName of a property
dataTypeData type of a property
propertySetPropertySet of a property
Returns
PidNamePropertyDescriptor object

◆ Parse()

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

Initializes a new instance of the PropertyDescriptor class

Parameters
dataA string that represents the property description.

◆ set_Use8BitStringAsUnicode()

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

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

◆ ThrowUnsupportedType()

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

◆ ToBytes() [1/4]

static ASPOSE_EMAIL_SHARED_API 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
pdThe property descriptor.
valueThe property data.

◆ ToBytes() [2/4]

static ASPOSE_EMAIL_SHARED_API 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
pdThe property descriptor.
valueThe property data.
dateTimeFormatInfoDateTime format provider.

◆ ToBytes() [3/4]

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

Converts value to binary data

Parameters
valueThe property data.

◆ ToBytes() [4/4]

ASPOSE_EMAIL_SHARED_API 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
valueThe property data.
dateTimeFormatInfoDateTime format provider.

Friends And Related Function Documentation

◆ Aspose::Email::Mapi::MapiAttachment

◆ Aspose::Email::Mapi::MapiMessageItemBase

◆ 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

◆ Aspose::Email::Mapi::PidLidPropertyDescriptor

◆ Aspose::Email::Mapi::PidNamePropertyDescriptor

◆ Aspose::Email::Mapi::PidTagPropertyDescriptor

◆ operator!=

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

◆ operator==

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