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#
Copy
public class PropertyMap : Disposable, IDisposable
Inheritance
PropertyMap
Implements

Constructors

View Source

PropertyMap()

The constructor.

Declaration
C#
Copy
public PropertyMap()
API Level: 3
View Source

PropertyMap(PropertyMap)

The copy constructor.

Declaration
C#
Copy
public PropertyMap(PropertyMap other)
Parameters
Type Name Description
PropertyMap other

The map to copy from.

API Level: 3

Properties

View Source

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#
Copy
public PropertyValue this[int key] { get; }
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
View Source

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#
Copy
public PropertyValue this[string key] { get; }
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

Methods

View Source

Add(Int32, PropertyValue)

Inserts the key-value pair in the map, with the key type as string.
Does not check for duplicates.

Declaration
C#
Copy
public 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
View Source

Add(String, PropertyValue)

Inserts the key-value pair in the map, with the key type as string.
Does not check for duplicates.

Declaration
C#
Copy
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.

API Level: 3
View Source

Add(KeyValue)

Inserts the keyvalue to the map.
Does not check for duplicates.

Declaration
C#
Copy
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
ArgumentNullException

Thrown when keyValue is null.

View Source

Clear()

Clears the map.

Declaration
C#
Copy
public void Clear()
API Level: 3
View Source

Count()

Retrieves the number of elements in the map.

Declaration
C#
Copy
public uint Count()
Returns
Type Description
UInt32

The number of elements in the map.

API Level: 3
View Source

Empty()

Returns whether the map is empty.

Declaration
C#
Copy
public bool Empty()
Returns
Type Description
Boolean

Returns true if empty, false otherwise.

API Level: 3
View Source

Find(Int32)

Finds the value for the specified key if it exists.

Declaration
C#
Copy
public 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
View Source

Find(Int32, String)

Finds the value for the specified keys if either exist.

Declaration
C#
Copy
public 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
View Source

GetKeyAt(UInt32)

Retrieves the key at the specified position.

Declaration
C#
Copy
public 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
View Source

GetValue(UInt32)

Retrieves the value at the specified position.

Declaration
C#
Copy
public 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
View Source

Insert(Int32, PropertyValue)

Inserts the key-value pair in the map, with the key type as index.
Does not check for duplicates.

Declaration
C#
Copy
public 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
View Source

Insert(String, PropertyValue)

Inserts the key-value pair in the map, with the key type as string.
Does not check for duplicates.

Declaration
C#
Copy
public 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
View Source

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#
Copy
public void Merge(PropertyMap from)
Parameters
Type Name Description
PropertyMap from

The map to merge from.

API Level: 3

Implements