Class PropertyMap
Definition
- Assembly:
- Tizen.NUI.dll
A map of property values, the key type could be string or Property::Index.
public class PropertyMap : Disposable- Inheritance
Constructors
View SourcePropertyMap()
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
View Sourcethis[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. |
Keys
Retrieves all keys.
Declaration
public IList<PropertyKey> Keys { get; }Property Value
| Type | Description |
|---|---|
| IList<><PropertyKey> | A list of keys. |
Values
Retrieves all values.
Declaration
public IList<PropertyValue> Values { get; }Property Value
| Type | Description |
|---|---|
| IList<><PropertyValue> | A list of values. |
Methods
View SourceAdd(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. |
Append(int, bool)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, bool value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| bool | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Append(int, int)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, int value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| int | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Append(int, float)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, float value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| float | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Append(int, string)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, string value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| string | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Append(int, PropertyMap)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, PropertyMap value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| PropertyMap | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Append(int, UIColor)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, UIColor value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| UIColor | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Append(int, UICorner)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, UICorner value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| UICorner | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Append(int, UIVector2)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, UIVector2 value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| UIVector2 | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Append(int, Vector2)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, Vector2 value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| Vector2 | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Append(int, Vector3)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, Vector3 value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| Vector3 | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Append(int, Vector4)
Append the key-value pair to the map. Does not check for duplicates.
Declaration
public PropertyMap Append(int key, Vector4 value)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The key to insert. |
| Vector4 | value | The value to insert. |
Returns
| Type | Description |
|---|---|
| PropertyMap | Returns a reference to this object. |
Clear()
Clears the map. This method removes all key-value pairs from the PropertyMap.
Declaration
public void Clear()Contains(PropertyKey)
Determines whether the PropertyMap contains the specified key.
Declaration
public bool Contains(PropertyKey key)Parameters
| Type | Name | Description |
|---|---|---|
| PropertyKey | key | The index key to find. |
Returns
| Type | Description |
|---|---|
| bool | True if it exists, false otherwise. |
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. |
Find(string)
Finds the value for the specified string key if it exists.
Declaration
public PropertyValue Find(string stringKey)Parameters
| Type | Name | Description |
|---|---|---|
| string | stringKey | The string 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. |
ReleaseSwigCPtr(HandleRef)
Declaration
protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)Parameters
| Type | Name | Description |
|---|---|---|
| System.Runtime.InteropServices.HandleRef | swigCPtr |
Overrides
View SourceRemove(int)
Removes the element by the specified integer key.
Declaration
public bool Remove(int key)Parameters
| Type | Name | Description |
|---|---|---|
| int | key | The index key to find. |
Returns
| Type | Description |
|---|---|
| bool | True if the element is removed, false otherwise. |
Remove(PropertyKey)
Removes the element by the specified key.
Declaration
public bool Remove(PropertyKey key)Parameters
| Type | Name | Description |
|---|---|---|
| PropertyKey | key | The index key to find. |
Returns
| Type | Description |
|---|---|
| bool | True if the element is removed, false otherwise. |