Class PropertyMap
Definition
- Namespace:
- Tizen.NUI
- Assembly:
- Tizen.NUI.dll
- API Level:
- 3
A map of property values, the key type could be string or Property::Index.
C#Copypublic class PropertyMap : Disposable
- Inheritance
Constructors
Declaration
C#Copypublic PropertyMap()
API Level: 3
Declaration
C#Copypublic PropertyMap(PropertyMap other)
Parameters
| Type | Name | Description |
|---|---|---|
| PropertyMap | other | The map to copy from. |
API Level: 3
Properties
Item[Int32]
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
C#Copypublic PropertyValue this[int key] { get; set; }
Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | key | The key whose value to access. |
Property Value
| Type | Description |
|---|---|
| PropertyValue | A value for the element with the specified key. |
API Level: 3
Item[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
C#Copypublic 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. |
API Level: 3
Declaration
C#Copypublic IList<PropertyKey> Keys { get; }
Property Value
| Type | Description |
|---|---|
| IList<PropertyKey> | A list of keys. |
Declaration
C#Copypublic IList<PropertyValue> Values { get; }
Property Value
| Type | Description |
|---|---|
| IList<PropertyValue> | A list of values. |
Methods
Add(Int32, 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
C#Copypublic PropertyMap Add(int key, PropertyValue value)
Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | key | The key to insert. |
| PropertyValue | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
API Level: 3
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
C#Copypublic 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. |
API Level: 3
Add(KeyValue)
Inserts the keyvalue to the map.
The exception would be thrown if the pair with the same key already exists.
Declaration
C#Copypublic PropertyMap Add(KeyValue keyValue)
Parameters
| Type | Name | Description |
|---|---|---|
| KeyValue | keyValue | The keyvalue to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Declaration
C#Copypublic void Clear()
API Level: 3
Declaration
C#Copypublic bool Contains(PropertyKey key)
Parameters
| Type | Name | Description |
|---|---|---|
| PropertyKey | key | The index key to find. |
Returns
| Type | Description |
|---|---|
| Boolean | True if it exists, false otherwise. |
Declaration
C#Copypublic uint Count()
Returns
| Type | Description |
|---|---|
| UInt32 | The number of elements in the map. |
API Level: 3
Declaration
C#Copypublic bool Empty()
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if empty, false otherwise. |
API Level: 3
Declaration
C#Copypublic PropertyValue Find(int key)
Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | key | The key to find. |
Returns
| Type | Description |
|---|---|
| PropertyValue | The value if it exists, an empty object otherwise. |
API Level: 3
Declaration
C#Copypublic PropertyValue Find(int indexKey, string stringKey)
Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | 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. |
API Level: 3
Declaration
C#Copypublic PropertyKey GetKeyAt(uint position)
Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | position | The specified position. |
Returns
| Type | Description |
|---|---|
| PropertyKey | A copy of the key at the specified position. |
API Level: 3
Declaration
C#Copypublic PropertyValue GetValue(uint position)
Parameters
| Type | Name | Description |
|---|---|---|
| UInt32 | position | The specified position. |
Returns
| Type | Description |
|---|---|
| PropertyValue | A reference to the value at the specified position. |
API Level: 3
Insert(Int32, 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
C#Copypublic void Insert(int key, PropertyValue value)
Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | key | The key to insert. |
| PropertyValue | value | The value to insert. |
API Level: 3
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
C#Copypublic void Insert(string key, PropertyValue value)
Parameters
| Type | Name | Description |
|---|---|---|
| String | key | The key to insert. |
| PropertyValue | value | The value to insert. |
API Level: 3
Merge(PropertyMap)
Merges values from the map 'from' to the current.
Any values in 'from' will overwrite the values in the current map.
Declaration
C#Copypublic void Merge(PropertyMap from)
Parameters
| Type | Name | Description |
|---|---|---|
| PropertyMap | from | The map to merge from. |
API Level: 3
Declaration
C#Copyprotected override void ReleaseSwigCPtr(Runtime.InteropServices.HandleRef swigCPtr)
Parameters
| Type | Name | Description |
|---|---|---|
| Tizen.System.Runtime.InteropServices.HandleRef | swigCPtr |
Overrides
Declaration
C#Copypublic bool Remove(PropertyKey key)
Parameters
| Type | Name | Description |
|---|---|---|
| PropertyKey | key | The index key to find. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the element is removed, false otherwise. |