-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Tizen.Applications.Preference</name>
- </assembly>
- <members>
- <member name="T:Interop">
- <summary>
- Contains interop declarations of the preference classes.
- </summary>
- </member>
- <member name="T:Interop.Preference">
- <summary>
- Contains interop declarations of the preference device API.
- </summary>
- </member>
- <member name="T:Tizen.Applications.Preference">
- <summary>
- The preference class provides APIs to store and retrieve an application specific data/preference. A preference is saved in the form of a key-value pair.
- Keys are always text strings and the value can be any one of the four types: integer, double, string, and boolean.
- </summary>
- </member>
- <member name="P:Tizen.Applications.Preference.Keys">
- <summary>
- Retrieves all keys of the application preferences.
- </summary>
- <value>
- The list of keys.
- </value>
- <example>
- <code>
- Preference.Set("Option_enabled", true);
- Preference.Set("active_user", "Joe");
- Preference.Set("default_volume", 10);
- Preference.Set("brightness", "0.6");
- foreach(string key in Preference.Keys)
- {
- Console.WriteLine("key {0}", key);
- }
- </code>
- </example>
- </member>
- <member name="M:Tizen.Applications.Preference.GetEventContext(System.String)">
- <summary>
- Gets the event context for the given key.
- </summary>
- <seealso cref="T:Tizen.Applications.Preference.EventContext"/>
- <param name="key">The preference key.</param>
- <returns>The event context of respective key.</returns>
- <exception cref="T:System.Collections.Generic.KeyNotFoundException">Thrown if the key is not found.</exception>
- <exception cref="T:System.ArgumentException">Thrown if the key is invalid parameter.</exception>
- <example>
- <code>
- private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e)
- {
- Console.WriteLine("key {0}", e.Key);
- }
-
- Preference.EventContext context = null;
- Preference.GetEventContext("active_user").TryGetTarget(out context);
- if(context != null)
- {
- context.Changed += Preference_PreferenceChanged;
- }
-
- Preference.Set("active_user", "Poe");
-
- Preference.GetEventContext("active_user").TryGetTarget(out context);
- if (context != null)
- {
- context.Changed -= Preference_PreferenceChanged;
- }
- </code>
- </example>
- </member>
- <!-- Badly formed XML comment ignored for member "M:Tizen.Applications.Preference.Contains(System.String)" -->
- <!-- Badly formed XML comment ignored for member "M:Tizen.Applications.Preference.Set(System.String,System.Object)" -->
- <!-- Badly formed XML comment ignored for member "M:Tizen.Applications.Preference.Get``1(System.String)" -->
- <member name="M:Tizen.Applications.Preference.Remove(System.String)">
- <summary>
- Removes any preference value with the given key.
- </summary>
- <param name="key">The key to remove.</param>
- <exception cref="T:System.Collections.Generic.KeyNotFoundException">Thrown if the key is not found.</exception>
- <exception cref="T:System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception>
- <example>
- <code>
- bool exists = Preference.Contains("active_user");
- if (exists)
- {
- string value = Preference.Remove("active_user");
- }
- </code>
- </example>
- </member>
- <member name="M:Tizen.Applications.Preference.RemoveAll">
- <summary>
- Removes all the key-value pairs from the preference.
- </summary>
- <exception cref="T:System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception>
- <example>
- <code>
- Preference.Set("Option_enabled", true);
- Preference.Set("active_user", "Joe");
- Preference.Set("default_volume", 10);
- Preference.Set("brightness", "0.6");
- Preference.RemoveAll();
- </code>
- </example>
- </member>
- <member name="T:Tizen.Applications.Preference.EventContext">
- <summary>
- The class manages event handlers of the preference keys. The class enables having event handlers for individual preference keys.
- </summary>
- </member>
- <member name="E:Tizen.Applications.Preference.EventContext.Changed">
- <summary>
- Occurs whenever there is a change in the value of a preference key.
- </summary>
- <exception cref="T:System.ArgumentException">Thrown when the key does not exist or when there is an invalid parameter.</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when the bundle instance has been disposed.</exception>
- <example>
- <code>
- private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e)
- {
- Console.WriteLine("key {0}", e.Key);
- }
- Preference.EventContext context = null;
- Preference.GetEventContext("active_user").TryGetTarget(out context);
- if(context != null)
- {
- context.Changed += Preference_PreferenceChanged;
- }
-
- Preference.Set("active_user", "Poe");
-
- Preference.GetEventContext("active_user").TryGetTarget(out context);
- if (context != null)
- {
- context.Changed -= Preference_PreferenceChanged;
- }
- </code>
- </example>
- </member>
- <member name="T:Tizen.Applications.PreferenceChangedEventArgs">
- <summary>
- This class is an event argument of the PreferenceChanged event.
- </summary>
- </member>
- <member name="P:Tizen.Applications.PreferenceChangedEventArgs.Key">
- <summary>
- The key of the preference whose value is changed.
- </summary>
- </member>
- </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+ <assembly>\r
+ <name>Tizen.Applications.Preference</name>\r
+ </assembly>\r
+ <members>\r
+ <member name="T:Interop">\r
+ <summary>\r
+ Contains interop declarations of the preference classes.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Interop.Preference">\r
+ <summary>\r
+ Contains interop declarations of the preference device API.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Preference">\r
+ <summary>\r
+ The preference class provides APIs to store and retrieve an application specific data/preference. A preference is saved in the form of a key-value pair.\r
+ Keys are always text strings and the value can be any one of the four types: integer, double, string, and boolean.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.Preference.Keys">\r
+ <summary>\r
+ Retrieves all keys of the application preferences.\r
+ </summary>\r
+ <value>\r
+ The list of keys.\r
+ </value>\r
+ <example>\r
+ <code>\r
+ Preference.Set("Option_enabled", true);\r
+ Preference.Set("active_user", "Joe");\r
+ Preference.Set("default_volume", 10);\r
+ Preference.Set("brightness", "0.6");\r
+ foreach(string key in Preference.Keys)\r
+ {\r
+ Console.WriteLine("key {0}", key);\r
+ }\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Preference.GetEventContext(System.String)">\r
+ <summary>\r
+ Gets the event context for the given key.\r
+ </summary>\r
+ <seealso cref="T:Tizen.Applications.Preference.EventContext"/>\r
+ <param name="key">The preference key.</param>\r
+ <returns>The event context of respective key.</returns>\r
+ <exception cref="T:System.Collections.Generic.KeyNotFoundException">Thrown if the key is not found.</exception>\r
+ <exception cref="T:System.ArgumentException">Thrown if the key is invalid parameter.</exception>\r
+ <example>\r
+ <code>\r
+ private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e)\r
+ {\r
+ Console.WriteLine("key {0}", e.Key);\r
+ }\r
+ \r
+ Preference.EventContext context = null;\r
+ Preference.GetEventContext("active_user").TryGetTarget(out context);\r
+ if(context != null)\r
+ {\r
+ context.Changed += Preference_PreferenceChanged;\r
+ }\r
+ \r
+ Preference.Set("active_user", "Poe");\r
+ \r
+ Preference.GetEventContext("active_user").TryGetTarget(out context);\r
+ if (context != null)\r
+ {\r
+ context.Changed -= Preference_PreferenceChanged;\r
+ }\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <!-- "M:Tizen.Applications.Preference.Contains(System.String)" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "M:Tizen.Applications.Preference.Set(System.String,System.Object)" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <!-- "M:Tizen.Applications.Preference.Get``1(System.String)" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+ <member name="M:Tizen.Applications.Preference.Remove(System.String)">\r
+ <summary>\r
+ Removes any preference value with the given key.\r
+ </summary>\r
+ <param name="key">The key to remove.</param>\r
+ <exception cref="T:System.Collections.Generic.KeyNotFoundException">Thrown if the key is not found.</exception>\r
+ <exception cref="T:System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception>\r
+ <example>\r
+ <code>\r
+ bool exists = Preference.Contains("active_user");\r
+ if (exists)\r
+ {\r
+ string value = Preference.Remove("active_user");\r
+ }\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="M:Tizen.Applications.Preference.RemoveAll">\r
+ <summary>\r
+ Removes all the key-value pairs from the preference.\r
+ </summary>\r
+ <exception cref="T:System.IO.IOException">Thrown when the method failed due to an internal I/O error.</exception>\r
+ <example>\r
+ <code>\r
+ Preference.Set("Option_enabled", true);\r
+ Preference.Set("active_user", "Joe");\r
+ Preference.Set("default_volume", 10);\r
+ Preference.Set("brightness", "0.6");\r
+ Preference.RemoveAll();\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="T:Tizen.Applications.Preference.EventContext">\r
+ <summary>\r
+ The class manages event handlers of the preference keys. The class enables having event handlers for individual preference keys.\r
+ </summary>\r
+ </member>\r
+ <member name="E:Tizen.Applications.Preference.EventContext.Changed">\r
+ <summary>\r
+ Occurs whenever there is a change in the value of a preference key.\r
+ </summary>\r
+ <exception cref="T:System.ArgumentException">Thrown when the key does not exist or when there is an invalid parameter.</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown when the bundle instance has been disposed.</exception>\r
+ <example>\r
+ <code>\r
+ private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e)\r
+ {\r
+ Console.WriteLine("key {0}", e.Key);\r
+ }\r
+ Preference.EventContext context = null;\r
+ Preference.GetEventContext("active_user").TryGetTarget(out context);\r
+ if(context != null)\r
+ {\r
+ context.Changed += Preference_PreferenceChanged;\r
+ }\r
+ \r
+ Preference.Set("active_user", "Poe");\r
+ \r
+ Preference.GetEventContext("active_user").TryGetTarget(out context);\r
+ if (context != null)\r
+ {\r
+ context.Changed -= Preference_PreferenceChanged;\r
+ }\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="T:Tizen.Applications.PreferenceChangedEventArgs">\r
+ <summary>\r
+ This class is an event argument of the PreferenceChanged event.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Applications.PreferenceChangedEventArgs.Key">\r
+ <summary>\r
+ The key of the preference whose value is changed.\r
+ </summary>\r
+ </member>\r
+ </members>\r
+</doc>\r
projects / platform / core / csapi / tizenfx.git / blobdiff