MapiPropertyCollection (Aspose.Email for Java 21.9 API Documentation)

java.lang.Object
- com.aspose.email.MapiPropertyCollection

All Implemented Interfaces:

INamedPropertyTagProvider, com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>, com.aspose.ms.System.Collections.Generic.IGenericDictionary<Long,MapiProperty>, com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>, com.aspose.ms.System.Collections.IEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>, Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
```
public class MapiPropertyCollection
extends Object
implements com.aspose.ms.System.Collections.Generic.IGenericDictionary<Long,MapiProperty>, INamedPropertyTagProvider
```
Represents the collection of MapiProperty items.

Constructor Summary

Constructors
Constructor and Description

MapiPropertyCollection()
Creates a new instance of class MapiProperty.

Constructors
Constructor and Description
`MapiPropertyCollection()` Creates a new instance of class MapiProperty.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> item)`
`void`	`add(long key, MapiProperty value)` Adds a MapiProperty item with specified tag.
`void`	`add(MapiProperty value)` Adds a MapiProperty item with specified tag.
`void`	`addItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> arg0)`
`void`	`addItem(Long arg0, MapiProperty arg1)`
`void`	`clear()` Removes all of the elements from the collection.
`boolean`	`contains(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> item)`
`boolean`	`containsItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> arg0)`
`boolean`	`containsKey(long key)` Determines whether the collection contains a property with the specified tag.
`boolean`	`containsKey(Long arg0)`
`void`	`copyTo(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>[] array, int arrayIndex)`
`void`	`copyToTArray(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>[] arg0, int arg1)`
`long`	`generateNamedPropertyTag(long dataType)` Generates named property tag
`MapiProperty`	`get_Item(long tag)` Gets or sets the value associated with the specified key.
`MapiProperty`	`get_Item(Long arg0)`
`MapiProperty`	`get_Item(PropertyDescriptor pd)` Gets or sets the value associated with the specified key.
`com.aspose.ms.System.Collections.Generic.IGenericCollection<Long>`	`get_Keys()` Gets a System.Collections.Generic.ICollection<long> containing the keys in the collection.
`com.aspose.ms.System.Collections.Generic.IGenericCollection<? extends MapiProperty>`	`get_Values()` Gets an System.Collections.Generic.ICollection<MapiProperty> containing the values in the collection.
`com.aspose.ms.System.Collections.Generic.IGenericCollection`	`getKeys()` Gets a System.Collections.Generic.ICollection<long> containing the keys in the collection.
`MapiProperty`	`getProperty(PropertyDescriptor pd)` Gets MAPI property by property descriptor.
`long`	`getTagFromNamedProperty(long LId)` Gets the tag from named property.
`long`	`getTagFromNamedProperty(String name)` Gets the tag from named property.
`com.aspose.ms.System.Collections.Generic.IGenericCollection`	`getValues()` Gets an System.Collections.Generic.ICollection<MapiProperty> containing the values in the collection.
`boolean`	`isReadOnly()` Gets a value indicating whether the collection is read only.
`com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>`	`iterator()`
`boolean`	`remove(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> item)`
`boolean`	`remove(long key)` Removes the property with the specified tag from the collection.
`boolean`	`remove(PropertyDescriptor pd)` Removes the property with the specified property descriptor from the collection.
`boolean`	`removeItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> arg0)`
`boolean`	`removeItemByKey(Long arg0)`
`void`	`set_Item(long tag, MapiProperty value)` Gets or sets the value associated with the specified key.
`void`	`set_Item(Long arg0, MapiProperty arg1)`
`void`	`set_Item(PropertyDescriptor pd, MapiProperty value)` Gets or sets the value associated with the specified key.
`protected void`	`setProperty(PropertyDescriptor pd, Object value)` Sets MAPI property.
`int`	`size()` Gets the number of elements contained in the collection.
`boolean`	`tryGetValue(long key, MapiProperty[] value)` Gets the property associated with the specified tag.
`boolean`	`tryGetValue(Long arg0, Object[] arg1)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapiPropertyCollection
```
public MapiPropertyCollection()
```
    Creates a new instance of class MapiProperty.
- Method Detail
  - generateNamedPropertyTag
```
public final long generateNamedPropertyTag(long dataType)
```
    Description copied from interface: INamedPropertyTagProvider
    
    Generates named property tag
    
    Specified by:
    
    generateNamedPropertyTag in interface INamedPropertyTagProvider
    
    Parameters:
    dataType - Named property data type
    
    Returns:
    Returns tag for named property for current tag provider
  - getTagFromNamedProperty
```
public final long getTagFromNamedProperty(long LId)
```
    Gets the tag from named property.
    
    Specified by:
    
    getTagFromNamedProperty in interface INamedPropertyTagProvider
    
    Parameters:
    LId - The property id.
    
    Returns:
    The property tag value.
  - getTagFromNamedProperty
```
public final long getTagFromNamedProperty(String name)
```
    Gets the tag from named property.
    
    Specified by:
    
    getTagFromNamedProperty in interface INamedPropertyTagProvider
    
    Parameters:
    name - The property name
    
    Returns:
    The property tag value.
    
    Throws:
    
    com.aspose.ms.System.ArgumentException - name is null or empty
  - getKeys
```
public final com.aspose.ms.System.Collections.Generic.IGenericCollection getKeys()
```
    Gets a System.Collections.Generic.ICollection<long> containing the keys in the collection.
    
    Specified by:
    
    getKeys in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<Long,MapiProperty>
  - getValues
```
public final com.aspose.ms.System.Collections.Generic.IGenericCollection getValues()
```
    Gets an System.Collections.Generic.ICollection<MapiProperty> containing the values in the collection.
    
    Specified by:
    
    getValues in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<Long,MapiProperty>
  - get_Keys
```
public final com.aspose.ms.System.Collections.Generic.IGenericCollection<Long> get_Keys()
```
    Gets a System.Collections.Generic.ICollection<long> containing the keys in the collection.
  - get_Values
```
public final com.aspose.ms.System.Collections.Generic.IGenericCollection<? extends MapiProperty> get_Values()
```
    Gets an System.Collections.Generic.ICollection<MapiProperty> containing the values in the collection.
  - size
```
public final int size()
```
    Gets the number of elements contained in the collection.
    
    Specified by:
    
    size in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
  - isReadOnly
```
public final boolean isReadOnly()
```
    Gets a value indicating whether the collection is read only.
    
    Specified by:
    
    isReadOnly in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
  - get_Item
```
public final MapiProperty get_Item(long tag)
```
    Gets or sets the value associated with the specified key.
    
    Parameters:
    tag - The tag key whose value to get or set.
    
    Returns:
    The value associated with the specified key.
  - set_Item
```
public final void set_Item(long tag,
            MapiProperty value)
```
    Gets or sets the value associated with the specified key.
    
    Parameters:
    tag - The tag key whose value to get or set.
  - get_Item
```
public final MapiProperty get_Item(PropertyDescriptor pd)
```
    Gets or sets the value associated with the specified key.
    
    Parameters:
    pd - The PropertyDescriptor key whose value to get or set.
    
    Returns:
    The value associated with the specified key.
  - set_Item
```
public final void set_Item(PropertyDescriptor pd,
            MapiProperty value)
```
    Gets or sets the value associated with the specified key.
    
    Parameters:
    pd - The PropertyDescriptor key whose value to get or set.
  - getProperty
```
public MapiProperty getProperty(PropertyDescriptor pd)
```
    Gets MAPI property by property descriptor.
    
    Parameters:
    pd - Property descriptor for looked property
    
    Returns:
    Mapi property if it is found, otherwise null.
  - setProperty
```
protected void setProperty(PropertyDescriptor pd,
               Object value)
```
    Sets MAPI property.
    
    Parameters:
    pd - The property descriptor.
    value - The property data.
  - add
```
public void add(long key,
       MapiProperty value)
```
    Adds a MapiProperty item with specified tag.
    
    Parameters:
    key - The property tag.
    value - The property value.
  - add
```
public void add(MapiProperty value)
```
    Adds a MapiProperty item with specified tag.
    
    Parameters:
    value - The property value.
  - containsKey
```
public final boolean containsKey(long key)
```
    Determines whether the collection contains a property with the specified tag.
    
    Parameters:
    key - The property tag.
    
    Returns:
    true if the collection contains a property with the tag; otherwise, false
  - remove
```
public final boolean remove(long key)
```
    Removes the property with the specified tag from the collection.
    
    Parameters:
    key - The tag of the property to remove.
    
    Returns:
    true if the property is successfully removed; otherwise, false.
  - remove
```
public final boolean remove(PropertyDescriptor pd)
```
    Removes the property with the specified property descriptor from the collection.
    
    Parameters:
    pd - Property descriptor of the property to remove.
    
    Returns:
    true if the property is successfully removed; otherwise, false.
  - tryGetValue
```
public final boolean tryGetValue(long key,
                  MapiProperty[] value)
```
    Gets the property associated with the specified tag.
    
    Parameters:
    key - The property tag.
    value -
    
    Returns:
  - add
```
public final void add(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> item)
```
  - clear
```
public final void clear()
```
    Removes all of the elements from the collection.
    
    Specified by:
    
    clear in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
  - contains
```
public final boolean contains(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> item)
```
  - copyTo
```
public final void copyTo(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>[] array,
          int arrayIndex)
```
  - remove
```
public final boolean remove(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> item)
```
  - iterator
```
public final com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>> iterator()
```
    Specified by:
    
    iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
    
    Specified by:
    
    iterator in interface com.aspose.ms.System.Collections.IEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
    
    Specified by:
    
    iterator in interface Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
  - addItem
```
public void addItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> arg0)
```
    Specified by:
    
    addItem in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
  - containsItem
```
public boolean containsItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> arg0)
```
    Specified by:
    
    containsItem in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
  - copyToTArray
```
public void copyToTArray(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>[] arg0,
                int arg1)
```
    Specified by:
    
    copyToTArray in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
  - removeItem
```
public boolean removeItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty> arg0)
```
    Specified by:
    
    removeItem in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<Long,MapiProperty>>
  - addItem
```
public void addItem(Long arg0,
           MapiProperty arg1)
```
    Specified by:
    
    addItem in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<Long,MapiProperty>
  - containsKey
```
public boolean containsKey(Long arg0)
```
    Specified by:
    
    containsKey in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<Long,MapiProperty>
  - get_Item
```
public MapiProperty get_Item(Long arg0)
```
    Specified by:
    
    get_Item in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<Long,MapiProperty>
  - removeItemByKey
```
public boolean removeItemByKey(Long arg0)
```
    Specified by:
    
    removeItemByKey in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<Long,MapiProperty>
  - set_Item
```
public void set_Item(Long arg0,
            MapiProperty arg1)
```
    Specified by:
    
    set_Item in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<Long,MapiProperty>
  - tryGetValue
```
public boolean tryGetValue(Long arg0,
                  Object[] arg1)
```
    Specified by:
    
    tryGetValue in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<Long,MapiProperty>

Class MapiPropertyCollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapiPropertyCollection

Method Detail

generateNamedPropertyTag

getTagFromNamedProperty

getTagFromNamedProperty

getKeys

getValues

get_Keys

get_Values

size

isReadOnly

get_Item

set_Item

get_Item

set_Item

getProperty

setProperty

add

add

containsKey

remove

remove

tryGetValue

add

clear

contains

copyTo

remove

iterator

addItem

containsItem

copyToTArray

removeItem

addItem

containsKey

get_Item

removeItemByKey

set_Item

tryGetValue