Aspose::Email::Mapi::MapiNamedPropertyMappingStorage Class Referencefinal

Represents the named property mapping More...

Inherits Aspose::Email::Mapi::MapiPropertyContainer.

Public Member Functions

System::String get_Name ()
 Gets the name More...
 
System::SharedPtr< System::Object > get_Content ()
 Gets the content More...
 
 MapiNamedPropertyMappingStorage ()
 Initializes a new instance of the MapiNamedPropertyMappingStorage class. More...
 
 MapiNamedPropertyMappingStorage (System::SharedPtr< MapiPropertyCollection > properties, System::SharedPtr< System::Collections::Generic::IList< System::Guid >> guidCollection, System::ArrayPtr< uint8_t > entryData, System::ArrayPtr< uint8_t > stringData)
 Initializes a new instance of the MapiNamedPropertyMappingStorage class. More...
 
bool TryGetNamedProperty (System::SharedPtr< MapiProperty > mapiProperty, System::SharedPtr< MapiNamedProperty > &mapiNamedProperty) override
 Gets the MapiNamedProperty that represent named property More...
 
int64_t GetNextAvailablePropertyId (MapiPropertyType dataType)
 Gets the next available property id in entries stream based on property datatype. More...
 
void AddNamedPropertyMapping (System::SharedPtr< MapiProperty > property, int64_t nameId, System::Guid guid)
 Adds the named property mapping for numeric named property. More...
 
void AddNamedPropertyMapping (System::SharedPtr< MapiProperty > property, System::String nameId, System::Guid guid)
 Adds the named property mapping for string named property. More...
 
System::SharedPtr< MapiNamedPropertyMappingStorageClone ()
 
- Public Member Functions inherited from Aspose::Email::Mapi::MapiPropertyContainer
virtual System::SharedPtr< MapiPropertyCollectionget_Properties ()
 Gets the collection of properties. More...
 
virtual int32_t get_CodePage ()
 Gets the code page. More...
 
System::SharedPtr< System::Text::Encoding > get_CurrentEncoding ()
 
 MapiPropertyContainer ()
 Initializes a new instance of the MapiPropertyContainer class. More...
 
 MapiPropertyContainer (System::SharedPtr< MapiPropertyCollection > properties)
 Initializes a new instance of the MapiPropertyContainer class. More...
 
virtual System::SharedPtr< MapiPropertyGetProperty (System::SharedPtr< PropertyDescriptor > pd)
 Gets MAPI property by property descriptor. More...
 
virtual void SetProperty (System::SharedPtr< PropertyDescriptor > pd, System::SharedPtr< System::Object > value)
 Sets MAPI property. More...
 
System::SharedPtr< MapiPropertyCollectionGetSubStorages ()
 
System::String TryGetPropertyString (int64_t tag, int32_t codepage)
 Try to get a property data as string with specified tag and code page. More...
 
System::ArrayPtr< uint8_t > TryGetPropertyData (int64_t tag)
 Try to get the property data with specified tag key. More...
 
System::String TryGetPropertyString (int64_t tag)
 Try to get a property data as string with specified tag. More...
 
System::String GetPropertyString (int64_t tag, int32_t codepage)
 Gets the string value of the property specified by tag. More...
 
System::String GetPropertyString (int64_t tag)
 Gets the string value of the property specified by tag. More...
 
System::ArrayPtr< uint8_t > GetPropertyBytes (int64_t tag)
 Gets the string value of the property specified by tag. More...
 
virtual void SetProperty (System::SharedPtr< MapiProperty > value)
 Sets the property. More...
 
System::Nullable< int32_t > GetPropertyInt32 (int64_t tag)
 Gets the int32 value of the property specified by tag. More...
 
System::Nullable< int64_t > GetPropertyLong (int64_t tag)
 Gets the value of the property specified by tag as Long (int64) type. More...
 
System::Nullable< int16_t > GetPropertyShort (int64_t tag)
 Gets the value of the property specified by tag as Short type. More...
 
System::Nullable< bool > GetPropertyBoolean (int64_t tag)
 Gets the value of the property specified by tag as Boolean type. More...
 
System::Nullable< System::DateTime > GetPropertyDateTime (int64_t key)
 Gets the value of the property specified by tag as DateTime type. More...
 
bool IsStoreUnicodeOk ()
 Determines if string properties are Unicode encoded or not. More...
 
bool TryGetPropertyString (int64_t tag, System::String &value, int32_t codepage)
 Gets the value of the specified property as String type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyString (int64_t tag, System::String &value)
 Gets the value of the specified property as String type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyDateTime (int64_t tag, System::DateTime &value)
 Gets the value of the specified property as DateTime type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyLong (int64_t tag, int64_t &value)
 Gets the value of the specified property as Long type. A return value indicates whether the operation succeeded. More...
 
bool TryGetPropertyInt32 (int64_t tag, int32_t &value)
 Gets the value of the specified property as Int32 type. A return value indicates whether the operation succeeded. More...
 
virtual System::SharedPtr< Nodes::IMapiNode > CreateMapiNode (System::String key)
 Creates the mapi node. More...
 
void SetProperty (int64_t tag, System::ArrayPtr< uint8_t > data)
 Set the property. More...
 
void SetProperty (int64_t tag, System::String value, OutlookMessageFormat format)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value, bool isUnicode)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value, System::SharedPtr< System::Text::Encoding > nonUnicodeEncoding)
 Set the string property. More...
 
void SetProperty (int64_t tag, System::String value)
 Set the string property with CurrentEncoding More...
 
void SetProperty (int64_t tag, System::DateTime dateTime)
 Set the datetime property. More...
 
void SetPropertyLong (int64_t tag, int64_t value)
 Set the long property. More...
 

Static Public Attributes

static System::Guid PS_PUBLIC_STRINGS
 Identifies PS_PUBLIC_STRINGS property set. More...
 
- Static Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
static const int32_t DefaultCodePage
 

Friends

class Aspose::Email::Mapi::MapiAttachment
 
class Aspose::Email::Mapi::MapiMessageItemBase
 
class Aspose::Email::Mapi::MapiMessage
 
class Aspose::Email::Mapi::MapiPropertyCollection
 
class Aspose::Email::Storage::Pst::PstDoer
 
class Aspose::Email::Tnef::TnefMessageProperty
 

Additional Inherited Members

- Public Attributes inherited from Aspose::Email::Mapi::MapiPropertyContainer
int32_t codePage
 The code page. More...
 
System::SharedPtr< MapiPropertyCollectionpropertyDictionary
 The property dictionary. More...
 

Detailed Description

Represents the named property mapping

Constructor & Destructor Documentation

◆ MapiNamedPropertyMappingStorage() [1/2]

Aspose::Email::Mapi::MapiNamedPropertyMappingStorage::MapiNamedPropertyMappingStorage ( )

Initializes a new instance of the MapiNamedPropertyMappingStorage class.

◆ MapiNamedPropertyMappingStorage() [2/2]

Aspose::Email::Mapi::MapiNamedPropertyMappingStorage::MapiNamedPropertyMappingStorage ( System::SharedPtr< MapiPropertyCollection properties,
System::SharedPtr< System::Collections::Generic::IList< System::Guid >>  guidCollection,
System::ArrayPtr< uint8_t >  entryData,
System::ArrayPtr< uint8_t >  stringData 
)

Initializes a new instance of the MapiNamedPropertyMappingStorage class.

Parameters
propertiesThe properties
guidCollectionThe GUID collection
entryDataThe entry data
stringDataThe string data

Member Function Documentation

◆ AddNamedPropertyMapping() [1/2]

void Aspose::Email::Mapi::MapiNamedPropertyMappingStorage::AddNamedPropertyMapping ( System::SharedPtr< MapiProperty property,
int64_t  nameId,
System::Guid  guid 
)

Adds the named property mapping for numeric named property.

Parameters
propertyThe property to add mapping for.
nameIdThe name id.
guidThe GUID identifying property set.

<exceptions> ArgumentNullException if property is null. ArgumentException if MapiProperty::Tag can'be used for named property mapping. The range for named property identifiers is between 0x8000 and 0xFFFE. </exceptions>

property should have a valid id for named property, GetNextAvailablePropertyId can be used to generate one. Otherwise an exception will be thrown.

◆ AddNamedPropertyMapping() [2/2]

void Aspose::Email::Mapi::MapiNamedPropertyMappingStorage::AddNamedPropertyMapping ( System::SharedPtr< MapiProperty property,
System::String  nameId,
System::Guid  guid 
)

Adds the named property mapping for string named property.

Parameters
propertyThe property to add mapping for.
nameIdThe name id.
guidThe GUID identifying property set.

<exceptions> ArgumentNullException if nameId is null. ArgumentNullException if property is null. ArgumentException if MapiProperty::Tag can'be used for named property mapping. The range for named property identifiers is between 0x8000 and 0xFFFE. </exceptions>

property should have a valid id for named property, GetNextAvailablePropertyId can be used to generate one. Otherwise an exception will be thrown.

◆ Clone()

System::SharedPtr<MapiNamedPropertyMappingStorage> Aspose::Email::Mapi::MapiNamedPropertyMappingStorage::Clone ( )

◆ get_Content()

System::SharedPtr<System::Object> Aspose::Email::Mapi::MapiNamedPropertyMappingStorage::get_Content ( )

Gets the content

The content

◆ get_Name()

System::String Aspose::Email::Mapi::MapiNamedPropertyMappingStorage::get_Name ( )

Gets the name

The name

◆ GetNextAvailablePropertyId()

int64_t Aspose::Email::Mapi::MapiNamedPropertyMappingStorage::GetNextAvailablePropertyId ( MapiPropertyType  dataType)

Gets the next available property id in entries stream based on property datatype.

Parameters
dataTypeType of the data for the property.
Returns
An id that can be lately used to add property mapping.

◆ TryGetNamedProperty()

bool Aspose::Email::Mapi::MapiNamedPropertyMappingStorage::TryGetNamedProperty ( System::SharedPtr< MapiProperty mapiProperty,
System::SharedPtr< MapiNamedProperty > &  mapiNamedProperty 
)
overridevirtual

Gets the MapiNamedProperty that represent named property

Parameters
mapiProperty
mapiNamedProperty
Returns

Reimplemented from Aspose::Email::Mapi::MapiPropertyContainer.

Friends And Related Function Documentation

◆ Aspose::Email::Mapi::MapiAttachment

◆ Aspose::Email::Mapi::MapiMessage

friend class Aspose::Email::Mapi::MapiMessage
friend

◆ Aspose::Email::Mapi::MapiMessageItemBase

◆ Aspose::Email::Mapi::MapiPropertyCollection

◆ Aspose::Email::Storage::Pst::PstDoer

friend class Aspose::Email::Storage::Pst::PstDoer
friend

◆ Aspose::Email::Tnef::TnefMessageProperty

friend class Aspose::Email::Tnef::TnefMessageProperty
friend

Member Data Documentation

◆ PS_PUBLIC_STRINGS

System::Guid Aspose::Email::Mapi::MapiNamedPropertyMappingStorage::PS_PUBLIC_STRINGS
static

Identifies PS_PUBLIC_STRINGS property set.