Class AppControl.ExtraDataCollection
Definition
- Namespace:
- Tizen.Applications
- Assembly:
- Tizen.Applications.Common.dll
- API Level:
- 3
Class for extra data.
C#Copypublic class ExtraDataCollection
- Inheritance
-
System.ObjectAppControl.ExtraDataCollection
Methods
Declaration
C#Copypublic void Add(string key, IEnumerable<string> value)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The name of the extra data. |
System.Collections.Generic.IEnumerable<System.String> | value | The value associated with the given key. |
Remarks
The function replaces any existing value for the given key.
Examples
CopyAppControl appControl = new AppControl(); string[] myValues = new string[] { "first", "second", "third" }; appControl.ExtraData.Add("myKey", myValues);
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when key or value is a zero-length string. |
System.ArgumentException | Thrown when the application tries to use the same key with the system-defined key. |
API Level: 3
Declaration
C#Copypublic void Add(string key, string value)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The name of the extra data. |
System.String | value | The value associated with the given key. |
Remarks
The function replaces any existing value for the given key.
Examples
CopyAppControl appControl = new AppControl(); appControl.ExtraData.Add("myKey", "myValue");
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when a key or a value is a zero-length string. |
System.ArgumentException | Thrown when the application tries to use the same key with the system-defined key. |
API Level: 3
Declaration
C#Copypublic int Count()
Returns
Type | Description |
---|---|
System.Int32 | The number of counting keys. |
Examples
CopyAppControl appControl = new AppControl(); int numberOfKeys = appControl.ExtraData.Count();
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when the key is an invalid parameter. |
API Level: 3
Declaration
C#Copypublic object Get(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The name of extra data. |
Returns
Type | Description |
---|---|
System.Object | The value associated with the given key. |
Examples
CopyAppControl appControl = new AppControl(); string myValue = appControl.ExtraData.Get("myKey") as string; if (myValue != null) { // ... }
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when the key is an invalid parameter. |
System.Collections.Generic.KeyNotFoundException | Thrown when the key is not found. |
System.ArgumentException | Thrown when the key is rejected. |
API Level: 3
Declaration
C#Copypublic T Get<T>(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The name of extra data. |
Returns
Type | Description |
---|---|
T | The value associated with the given key. |
Type Parameters
Name | Description |
---|---|
T | Only string and IEnumerable<string> |
Examples
CopyAppControl appControl = new AppControl(); string myValue = appControl.ExtraData.Get<string>("myKey");
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when the key is an invalid parameter. |
System.Collections.Generic.KeyNotFoundException | Thrown when the key is not found. |
System.ArgumentException | Thrown when the key is rejected. |
API Level: 3
Declaration
C#Copypublic IEnumerable<string> GetKeys()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | The keys in the AppControl. |
Examples
CopyAppControl appControl = new AppControl(); IEnumerable<string> keys = appControl.GetKeys(); if (keys != null) { foreach (string key in keys) { // ... } }
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when the key is an invalid parameter. |
API Level: 3
IsCollection(String)
Checks whether the extra data associated with the given key is of the collection data type.
Declaration
C#Copypublic bool IsCollection(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The name of the extra data. |
Returns
Type | Description |
---|---|
System.Boolean | If true, the extra data is of the array data type, otherwise false. |
Examples
CopyAppControl appControl = new AppControl(); bool result = appControl.ExtraData.IsCollection("myKey");
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when the key is a zero-length string. |
System.InvalidOperationException | Thrown when failed to check the key. |
API Level: 3
Declaration
C#Copypublic void Remove(string key)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The name of the extra data. |
Examples
CopyAppControl appControl = new AppControl(); appControl.ExtraData.Remove("myKey");
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when the key is a zero-length string. |
System.Collections.Generic.KeyNotFoundException | Thrown when the key is not found. |
System.ArgumentException | Thrown when the key is rejected. |
API Level: 3
Declaration
C#Copypublic bool TryGet(string key, out IEnumerable<string> value)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The name of extra data. |
System.Collections.Generic.IEnumerable<System.String> | value | The value associated with the given key. |
Returns
Type | Description |
---|---|
System.Boolean | The result whether getting the value is done. |
Examples
CopyAppControl appControl = new AppControl(); IEnumerable<string> myValue = null; bool result = appControl.ExtraData.TryGet("myKey", out myValue); if (result) { foreach (string value in myValue) { // ... } }
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when the key is an invalid parameter. |
System.Collections.Generic.KeyNotFoundException | Thrown when the key is not found. |
System.ArgumentException | Thrown when the key is rejected. |
API Level: 3
Declaration
C#Copypublic bool TryGet(string key, out string value)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | The name of extra data. |
System.String | value | The value associated with the given key. |
Returns
Type | Description |
---|---|
System.Boolean | The result whether getting the value is done. |
Examples
CopyAppControl appControl = new AppControl(); string myValue = string.Empty; bool result = appControl.ExtraData.TryGet("myKey", out myValue); if (result != null) { // ... }
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when the key is an invalid parameter. |
System.Collections.Generic.KeyNotFoundException | Thrown when the key is not found. |
System.ArgumentException | Thrown when the key is rejected. |