From 06cd2843d23558842b90ff7e830d00ce2bbe01d2 Mon Sep 17 00:00:00 2001 From: "jh5.cho" Date: Mon, 3 Apr 2017 15:50:08 +0900 Subject: [PATCH] Enhance documents for ColorSelector and DropdownList Change-Id: I5d278e01be5af53fb39131dfda77be78e9fd7618 Signed-off-by: jh5.cho --- .../ColorChangedEventArgs.cs | 48 +++++++++++++--------- Tizen.Xamarin.Forms.Extension/ColorSelector.cs | 7 ++-- Tizen.Xamarin.Forms.Extension/DropdownList.cs | 11 +++-- 3 files changed, 40 insertions(+), 26 deletions(-) diff --git a/Tizen.Xamarin.Forms.Extension/ColorChangedEventArgs.cs b/Tizen.Xamarin.Forms.Extension/ColorChangedEventArgs.cs index 98d57cc..a770fe2 100755 --- a/Tizen.Xamarin.Forms.Extension/ColorChangedEventArgs.cs +++ b/Tizen.Xamarin.Forms.Extension/ColorChangedEventArgs.cs @@ -1,19 +1,29 @@ -using System; -using Xamarin.Forms; - -namespace Tizen.Xamarin.Forms.Extension -{ - public class ColorChangedEventArgs : EventArgs - { - public ColorChangedEventArgs(Color oldColor, Color newColor) - { - OldColor = oldColor; - NewColor = newColor; - } - - public Color OldColor { get; private set; } - - public Color NewColor { get; private set; } - - } -} \ No newline at end of file +using System; +using Xamarin.Forms; + +namespace Tizen.Xamarin.Forms.Extension +{ + /// + /// Arguments for the event that is raised when SelectedColor is changed. + /// The SelectedColor can be changed by either tapping the color on the palette or setting the color value. + /// + public class ColorChangedEventArgs : EventArgs + { + public ColorChangedEventArgs(Color oldColor, Color newColor) + { + OldColor = oldColor; + NewColor = newColor; + } + + /// + /// The old SelectedColor which will be replaced by a newColor momentarily. + /// + public Color OldColor { get; private set; } + + /// + /// The new SelectedColor, taking place of an old SelectedColor. + /// + public Color NewColor { get; private set; } + + } +} diff --git a/Tizen.Xamarin.Forms.Extension/ColorSelector.cs b/Tizen.Xamarin.Forms.Extension/ColorSelector.cs index 58e3fa6..f0b0c20 100755 --- a/Tizen.Xamarin.Forms.Extension/ColorSelector.cs +++ b/Tizen.Xamarin.Forms.Extension/ColorSelector.cs @@ -7,6 +7,7 @@ namespace Tizen.Xamarin.Forms.Extension { /// /// The ColorSelector class allows the user to select a color. + /// The colors can be picked by the user from the color set by clicking on individual color items on the palette. /// /// /// @@ -23,8 +24,8 @@ namespace Tizen.Xamarin.Forms.Extension public static readonly BindableProperty SelectedColorProperty = BindableProperty.Create("SelectedColor", typeof(Color), typeof(ColorSelector), Color.Default, propertyChanged: OnSelectedColorChanged ); /// - /// Get or set current selected color from ColorSelector - /// Default value is Color.Default + /// Get or set current selected color from ColorSelector. + /// Default value is Color.Default. /// public Color SelectedColor { @@ -33,7 +34,7 @@ namespace Tizen.Xamarin.Forms.Extension } /// - /// Occurs when the SelectedColor value changes + /// Occurs when the SelectedColor value changes. /// public event EventHandler ColorChanged; diff --git a/Tizen.Xamarin.Forms.Extension/DropdownList.cs b/Tizen.Xamarin.Forms.Extension/DropdownList.cs index 80d9107..074cd67 100755 --- a/Tizen.Xamarin.Forms.Extension/DropdownList.cs +++ b/Tizen.Xamarin.Forms.Extension/DropdownList.cs @@ -8,11 +8,13 @@ using Xamarin.Forms; namespace Tizen.Xamarin.Forms.Extension { /// - /// The DropdownList class + /// The DropdownList is a button like widget that pops up a list of items(automatically choosing the direction to display) that have a string label. + /// It is a convenience widget to avoid the need to do all the piecing together yourself. + /// It is intended for a small number of items in the dropdownList menu (no more than 8), though is capable of many more. /// /// /// - /// var dropdownList = new DropdownList() + /// var dropdownList = new DropdownList(); /// dropdownList.ItemSelected += (s, e) => /// { /// Debug.WriteLine("e.Selected Item: " + e.SelectedItem); @@ -38,8 +40,9 @@ namespace Tizen.Xamarin.Forms.Extension public static readonly BindableProperty DisplayMemberPathProperty = BindableProperty.Create("DisplayMemberPath", typeof(string), typeof(DropdownList), default(string), propertyChanged: OnDisplayMemberPathChanged); - /// - /// Occurs when an item in the DropdownList is selected. + /// + /// Occurs when an item in the DropdownList is selected. + /// SelectedItemChangedEventArgs will also have the selected item. /// public event EventHandler ItemSelected; -- 2.7.4