Aspose::Email::Mapi::MapiPropertyCollection Class Reference

Represents the collection of MapiProperty items. More...

Inherits System::Collections::Generic::IDictionary< int64_t, System::SharedPtr< Aspose::Email::Mapi::MapiProperty > >, and Aspose::Email::Mapi::INamedPropertyTagProvider.

Public Member Functions

System::ArrayPtr< uint8_t > get_RtfDecompressed ()
 Cache for decompressed rtf More...
 
System::SharedPtr< System::Collections::Generic::ICollection< int64_t > > get_Keys () const override
 Gets a System.Collections.Generic.ICollection<long> containing the keys in the collection. More...
 
System::ArrayPtr< int64_t > get_KeysCopy ()
 
System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< MapiProperty > > > get_Values () const override
 Gets an System.Collections.Generic.ICollection<MapiProperty> containing the values in the collection. More...
 
int32_t get_Count () const override
 Gets the number of elements contained in the collection. More...
 
bool get_IsReadOnly () const override
 Gets a value indicating whether the collection is read only. More...
 
 MapiPropertyCollection ()
 Creates a new instance of class MapiProperty. More...
 
System::SharedPtr< MapiPropertyidx_get (int64_t const &tag) const override
 Gets the value associated with the specified key. More...
 
void idx_set (int64_t const &tag, System::SharedPtr< MapiProperty > value) override
 Sets the value associated with the specified key. More...
 
System::SharedPtr< MapiPropertyidx_get (System::SharedPtr< PropertyDescriptor > const &pd) const
 Gets the value associated with the specified key. More...
 
void idx_set (System::SharedPtr< PropertyDescriptor > const &pd, System::SharedPtr< MapiProperty > value)
 Sets the value associated with the specified key. 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...
 
virtual void SetProperty (System::SharedPtr< MapiProperty > property)
 Sets the property. More...
 
void Add (int64_t const &key, System::SharedPtr< MapiProperty > const &value) override
 Adds a MapiProperty item with specified tag. More...
 
virtual void Add (System::SharedPtr< MapiProperty > const &value)
 Adds a MapiProperty item with specified tag. More...
 
int32_t GetSize ()
 Gets the total size of property values. More...
 
System::SharedPtr< MapiPropertyCollectionExtractNamedProperties (System::SharedPtr< MapiNamedPropertyMappingStorage > mappingStorage)
 Extracts the collection of MapiNamedProperties. More...
 
bool ContainsKey (int64_t const &key) const override
 Determines whether the collection contains a property with the specified tag. More...
 
bool Remove (int64_t const &key) override
 Removes the property with the specified tag from the collection. More...
 
bool TryGetValue (int64_t const &key, System::SharedPtr< MapiProperty > &value) const override
 Gets the property associated with the specified tag. More...
 
void Add (System::Collections::Generic::KeyValuePair< int64_t, System::SharedPtr< MapiProperty >> const &item) override
 
void Clear () override
 Removes all of the elements from the collection. More...
 
bool Contains (System::Collections::Generic::KeyValuePair< int64_t, System::SharedPtr< MapiProperty >> const &item) const override
 
void CopyTo (System::ArrayPtr< System::Collections::Generic::KeyValuePair< int64_t, System::SharedPtr< MapiProperty >>> array, int32_t arrayIndex) override
 
bool Remove (System::Collections::Generic::KeyValuePair< int64_t, System::SharedPtr< MapiProperty >> const &item) override
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::Collections::Generic::KeyValuePair< int64_t, System::SharedPtr< MapiProperty > > > > GetEnumerator () override
 
void DeepCopyTo (System::SharedPtr< MapiPropertyCollection > dest)
 

Protected Member Functions

virtual ~MapiPropertyCollection ()
 

Friends

class Aspose::Email::Clients::Graph::V1::Commands::CopyFolderCommand
 
class Aspose::Email::Clients::Graph::V1::Commands::CopyMessageCommand
 
class Aspose::Email::Clients::Graph::V1::Commands::CreateFolderCommand
 
class Aspose::Email::Clients::Graph::V1::Commands::CreateMessageCommand
 
class Aspose::Email::Clients::Graph::V1::Commands::GetFolderCommand
 
class Aspose::Email::Clients::Graph::V1::Commands::GetMessageCommand
 
class Aspose::Email::Clients::Graph::V1::Commands::ListFoldersCommand
 
class Aspose::Email::Clients::Graph::V1::Commands::ListMessagesCommand
 
class Aspose::Email::Clients::Graph::V1::Commands::UpdateFolderCommand
 
class Aspose::Email::Clients::Graph::V1::Commands::UpdateMessageCommand
 
class Aspose::Email::Clients::Graph::V1::Model::TLMailMessage
 
class Aspose::Email::Mapi::MailMessageInterpretor
 
class Aspose::Email::Mapi::MapiAttachment
 
class Aspose::Email::Mapi::MapiPropertyContainer
 
class Aspose::Email::Mapi::MapiMessageItemBase
 
class Aspose::Email::Mapi::MapiMessage
 
class Aspose::Email::Mapi::MapiNamedPropertyMappingStorage
 
class Aspose::Email::Mapi::MapiObjectProperty
 
class Aspose::Email::Mapi::MapiRecipient
 
class Aspose::Email::Storage::Pst::FolderInfo
 
class Aspose::Email::Storage::Pst::Ltp::PropertyContext
 

Detailed Description

Represents the collection of MapiProperty items.

Constructor & Destructor Documentation

◆ MapiPropertyCollection()

Aspose::Email::Mapi::MapiPropertyCollection::MapiPropertyCollection ( )

Creates a new instance of class MapiProperty.

◆ ~MapiPropertyCollection()

virtual Aspose::Email::Mapi::MapiPropertyCollection::~MapiPropertyCollection ( )
protectedvirtual

Member Function Documentation

◆ Add() [1/3]

void Aspose::Email::Mapi::MapiPropertyCollection::Add ( int64_t const &  key,
System::SharedPtr< MapiProperty > const &  value 
)
override

Adds a MapiProperty item with specified tag.

Parameters
keyThe property tag.
valueThe property value.

◆ Add() [2/3]

void Aspose::Email::Mapi::MapiPropertyCollection::Add ( System::Collections::Generic::KeyValuePair< int64_t, System::SharedPtr< MapiProperty >> const &  item)
override

◆ Add() [3/3]

virtual void Aspose::Email::Mapi::MapiPropertyCollection::Add ( System::SharedPtr< MapiProperty > const &  value)
virtual

Adds a MapiProperty item with specified tag.

Parameters
valueThe property value.

◆ Clear()

void Aspose::Email::Mapi::MapiPropertyCollection::Clear ( )
override

Removes all of the elements from the collection.

◆ Contains()

bool Aspose::Email::Mapi::MapiPropertyCollection::Contains ( System::Collections::Generic::KeyValuePair< int64_t, System::SharedPtr< MapiProperty >> const &  item) const
override

◆ ContainsKey()

bool Aspose::Email::Mapi::MapiPropertyCollection::ContainsKey ( int64_t const &  key) const
override

Determines whether the collection contains a property with the specified tag.

Parameters
keyThe property tag.
Returns
true if the collection contains a property with the tag; otherwise, false

◆ CopyTo()

void Aspose::Email::Mapi::MapiPropertyCollection::CopyTo ( System::ArrayPtr< System::Collections::Generic::KeyValuePair< int64_t, System::SharedPtr< MapiProperty >>>  array,
int32_t  arrayIndex 
)
override

◆ DeepCopyTo()

void Aspose::Email::Mapi::MapiPropertyCollection::DeepCopyTo ( System::SharedPtr< MapiPropertyCollection dest)

◆ ExtractNamedProperties()

System::SharedPtr<MapiPropertyCollection> Aspose::Email::Mapi::MapiPropertyCollection::ExtractNamedProperties ( System::SharedPtr< MapiNamedPropertyMappingStorage mappingStorage)

Extracts the collection of MapiNamedProperties.

Parameters
mappingStorageThe mapping storage.
Returns

◆ get_Count()

int32_t Aspose::Email::Mapi::MapiPropertyCollection::get_Count ( ) const
override

Gets the number of elements contained in the collection.

◆ get_IsReadOnly()

bool Aspose::Email::Mapi::MapiPropertyCollection::get_IsReadOnly ( ) const
override

Gets a value indicating whether the collection is read only.

◆ get_Keys()

System::SharedPtr<System::Collections::Generic::ICollection<int64_t> > Aspose::Email::Mapi::MapiPropertyCollection::get_Keys ( ) const
override

Gets a System.Collections.Generic.ICollection<long> containing the keys in the collection.

◆ get_KeysCopy()

System::ArrayPtr<int64_t> Aspose::Email::Mapi::MapiPropertyCollection::get_KeysCopy ( )

◆ get_RtfDecompressed()

System::ArrayPtr<uint8_t> Aspose::Email::Mapi::MapiPropertyCollection::get_RtfDecompressed ( )

Cache for decompressed rtf

◆ get_Values()

System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<MapiProperty> > > Aspose::Email::Mapi::MapiPropertyCollection::get_Values ( ) const
override

Gets an System.Collections.Generic.ICollection<MapiProperty> containing the values in the collection.

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::Collections::Generic::KeyValuePair<int64_t, System::SharedPtr<MapiProperty> > > > Aspose::Email::Mapi::MapiPropertyCollection::GetEnumerator ( )
override

◆ GetProperty()

virtual System::SharedPtr<MapiProperty> Aspose::Email::Mapi::MapiPropertyCollection::GetProperty ( System::SharedPtr< PropertyDescriptor pd)
virtual

Gets MAPI property by property descriptor.

Parameters
pdProperty descriptor for looked property
Returns
Mapi property if it is found, otherwise null.

◆ GetSize()

int32_t Aspose::Email::Mapi::MapiPropertyCollection::GetSize ( )

Gets the total size of property values.

Returns
The size of property values.

◆ idx_get() [1/2]

System::SharedPtr<MapiProperty> Aspose::Email::Mapi::MapiPropertyCollection::idx_get ( int64_t const &  tag) const
override

Gets the value associated with the specified key.

Parameters
tagThe tag key whose value to get or set.
Returns
The value associated with the specified key.

◆ idx_get() [2/2]

System::SharedPtr<MapiProperty> Aspose::Email::Mapi::MapiPropertyCollection::idx_get ( System::SharedPtr< PropertyDescriptor > const &  pd) const

Gets the value associated with the specified key.

Parameters
pdThe PropertyDescriptor key whose value to get or set.
Returns
The value associated with the specified key.

◆ idx_set() [1/2]

void Aspose::Email::Mapi::MapiPropertyCollection::idx_set ( int64_t const &  tag,
System::SharedPtr< MapiProperty value 
)
override

Sets the value associated with the specified key.

Parameters
tagThe tag key whose value to get or set.
valueThe value associated with the specified key.

◆ idx_set() [2/2]

void Aspose::Email::Mapi::MapiPropertyCollection::idx_set ( System::SharedPtr< PropertyDescriptor > const &  pd,
System::SharedPtr< MapiProperty value 
)

Sets the value associated with the specified key.

Parameters
pdThe PropertyDescriptor key whose value to get or set.
valueThe value associated with the specified key.

◆ Remove() [1/2]

bool Aspose::Email::Mapi::MapiPropertyCollection::Remove ( int64_t const &  key)
override

Removes the property with the specified tag from the collection.

Parameters
keyThe tag of the property to remove.
Returns
true if the property is successfully removed; otherwise, false.

◆ Remove() [2/2]

bool Aspose::Email::Mapi::MapiPropertyCollection::Remove ( System::Collections::Generic::KeyValuePair< int64_t, System::SharedPtr< MapiProperty >> const &  item)
override

◆ SetProperty() [1/2]

virtual void Aspose::Email::Mapi::MapiPropertyCollection::SetProperty ( System::SharedPtr< MapiProperty property)
virtual

Sets the property.

Parameters
propertyThe property.
Exceptions
ArgumentNullExceptionIf property is null.
ArgumentExceptionIf property data is null.
InvalidOperationExceptionIf data type is not supported.

◆ SetProperty() [2/2]

virtual void Aspose::Email::Mapi::MapiPropertyCollection::SetProperty ( System::SharedPtr< PropertyDescriptor pd,
System::SharedPtr< System::Object >  value 
)
virtual

Sets MAPI property.

Parameters
pdThe property descriptor.
valueThe property data.

◆ TryGetValue()

bool Aspose::Email::Mapi::MapiPropertyCollection::TryGetValue ( int64_t const &  key,
System::SharedPtr< MapiProperty > &  value 
) const
override

Gets the property associated with the specified tag.

Parameters
keyThe property tag.
value
Returns

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Graph::V1::Commands::CopyFolderCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::CopyFolderCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::CopyMessageCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::CopyMessageCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::CreateFolderCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::CreateFolderCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::CreateMessageCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::CreateMessageCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::GetFolderCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::GetFolderCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::GetMessageCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::GetMessageCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::ListFoldersCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::ListFoldersCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::ListMessagesCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::ListMessagesCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::UpdateFolderCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::UpdateFolderCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::UpdateMessageCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::UpdateMessageCommand
friend

◆ Aspose::Email::Clients::Graph::V1::Model::TLMailMessage

friend class Aspose::Email::Clients::Graph::V1::Model::TLMailMessage
friend

◆ Aspose::Email::Mapi::MailMessageInterpretor

friend class Aspose::Email::Mapi::MailMessageInterpretor
friend

◆ Aspose::Email::Mapi::MapiAttachment

◆ Aspose::Email::Mapi::MapiMessage

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

◆ Aspose::Email::Mapi::MapiMessageItemBase

◆ Aspose::Email::Mapi::MapiNamedPropertyMappingStorage

◆ Aspose::Email::Mapi::MapiObjectProperty

◆ Aspose::Email::Mapi::MapiPropertyContainer

◆ Aspose::Email::Mapi::MapiRecipient

◆ Aspose::Email::Storage::Pst::FolderInfo

◆ Aspose::Email::Storage::Pst::Ltp::PropertyContext

friend class Aspose::Email::Storage::Pst::Ltp::PropertyContext
friend