Class PropertyMap

Definition

Namespace:

Tizen.NUI

Assembly:

Tizen.NUI.dll

A map of property values, the key type could be string or Property::Index.

public class PropertyMap : Disposable, IDisposable

Inheritance

object

Disposable

PropertyMap

Implements

System.IDisposable

Constructors

PropertyMap()

Default constructor of PropertyMap class.

Declaration

public PropertyMap()

PropertyMap(PropertyMap)

The copy constructor.

Declaration

public PropertyMap(PropertyMap other)

Parameters

Type	Name	Description
PropertyMap	other	The map to copy from.

Properties

this[int]

The operator to access the element with the specified index key.
If an element with the key does not exist, then it is created.

Declaration

public PropertyValue this[int key] { get; set; }

Parameters

Type	Name	Description
int	key	The key whose value to access.

Property Value

Type	Description
PropertyValue	A value for the element with the specified key.

this[string]

The operator to access the element with the specified string key.
If an element with the key does not exist, then it is created.

Declaration

public PropertyValue this[string key] { get; set; }

Parameters

Type	Name	Description
string	key	The key whose value to access.

Property Value

Type	Description
PropertyValue	A value for the element with the specified key.

Methods

Add(int, PropertyValue)

Inserts the key-value pair in the map, with the key type as string.
The error message would be shown if the pair with the same key already exists.

Declaration

public PropertyMap Add(int key, PropertyValue value)

Parameters

Type	Name	Description
int	key	The key to insert.
PropertyValue	value	The value to insert.

Returns

Type	Description
PropertyMap	Returns a reference to this object.

Add(string, PropertyValue)

Inserts the key-value pair in the map, with the key type as string.
The error message would be shown if the pair with the same key already exists.

Declaration

public PropertyMap Add(string key, PropertyValue value)

Parameters

Type	Name	Description
string	key	The key to insert.
PropertyValue	value	The value to insert.

Returns

Type	Description
PropertyMap	Returns a reference to this object.

Add(KeyValue)

Inserts the keyvalue to the map.
The exception would be thrown if the pair with the same key already exists.

Declaration

public PropertyMap Add(KeyValue keyValue)

Parameters

Type	Name	Description
KeyValue	keyValue	The keyvalue to insert.

Returns

Type	Description
PropertyMap	Returns a reference to this object.

Exceptions

Type	Condition
System.ArgumentNullException	Thrown when keyValue is null.

Clear()

Clears the map. This method removes all key-value pairs from the PropertyMap.

Declaration

public void Clear()

Count()

Retrieves the number of elements in the map.

Declaration

public uint Count()

Returns

Type	Description
uint	The number of elements in the map.

Empty()

Returns whether the map is empty.

Declaration

public bool Empty()

Returns

Type	Description
bool	Returns true if empty, false otherwise.

Find(int, string)

Finds the value for the specified keys if either exist.

Declaration

public PropertyValue Find(int indexKey, string stringKey)

Parameters

Type	Name	Description
int	indexKey	The index key to find.
string	stringKey	The string key to find.

Returns

Type	Description
PropertyValue	The value if it exists, an empty object otherwise.

Find(int)

Finds the value for the specified key if it exists.

Declaration

public PropertyValue Find(int key)

Parameters

Type	Name	Description
int	key	The key to find.

Returns

Type	Description
PropertyValue	The value if it exists, an empty object otherwise.

GetKeyAt(uint)

Retrieves the key at the specified position.

Declaration

public PropertyKey GetKeyAt(uint position)

Parameters

Type	Name	Description
uint	position	The specified position.

Returns

Type	Description
PropertyKey	A copy of the key at the specified position.

GetValue(uint)

Retrieves the value at the specified position.

Declaration

public PropertyValue GetValue(uint position)

Parameters

Type	Name	Description
uint	position	The specified position.

Returns

Type	Description
PropertyValue	A reference to the value at the specified position.

Insert(int, PropertyValue)

Inserts the key-value pair in the map, with the key type as index.
The error message would be shown if the pair with the same key already exists.

Declaration

public void Insert(int key, PropertyValue value)

Parameters

Type	Name	Description
int	key	The key to insert.
PropertyValue	value	The value to insert.

Insert(string, PropertyValue)

Inserts the key-value pair in the map, with the key type as string.
The error message would be shown if the pair with the same key already exists.

Declaration

public void Insert(string key, PropertyValue value)

Parameters

Type	Name	Description
string	key	The key to insert.
PropertyValue	value	The value to insert.

Merge(PropertyMap)

Merges values from the map 'from' to the current.
Any values in 'from' will overwrite the values in the current map.

Declaration

public void Merge(PropertyMap from)

Parameters

Type	Name	Description
PropertyMap	from	The map to merge from.

Implements

System.IDisposable