namespace Tizen.Xamarin.Forms.Extension
{
+ /// <summary>
+ /// Background class provides the properties for Background.
+ /// </summary>
+ /// <example>
+ /// <code>
+ /// new Background
+ /// {
+ /// Image = new FileImageSource { File = "icon.png" },
+ /// Option = BackgroundOptions.Tile,
+ /// }
+ /// </code>
+ /// </example>
public class Background : View
{
public static readonly BindableProperty ImageProperty = BindableProperty.Create("Image", typeof(FileImageSource), typeof(Background), default(FileImageSource));
public static readonly BindableProperty OptionProperty = BindableProperty.Create("Option", typeof(BackgroundOptions), typeof(Background), BackgroundOptions.Scale);
+ /// <summary>
+ /// Gets or Sets the Image on the background. This identifier is the image path to the image.
+ /// </summary>
public FileImageSource Image
{
get { return (FileImageSource)GetValue(ImageProperty); }
set { SetValue(ImageProperty, value); }
}
+ /// <summary>
+ /// Gets or Sets the BackgroundOption on the background. This identifiers on how a background is to display its image.
+ /// </summary>
public BackgroundOptions Option
{
get { return (BackgroundOptions)GetValue(OptionProperty); }
namespace Tizen.Xamarin.Forms.Extension
{
+ /// <summary>
+ /// Enumeration of identifiers on how a background widget is to display its image, if it is set to use an image file.
+ /// </summary>
public enum BackgroundOptions
{
+ /// <summary>
+ /// Center the background image
+ /// </summary>
Center,
+ /// <summary>
+ /// Scale the background image, retaining the aspect ratio
+ /// </summary>
Scale,
+ /// <summary>
+ /// Stretch the background image to fill the widget's area
+ /// </summary>
Stretch,
+ /// <summary>
+ /// Tile background image at its original size
+ /// </summary>
Tile
}
}
namespace Tizen.Xamarin.Forms.Extension
{
+ /// <summary>
+ /// BaseTypeCell containing Text, TextEnd, Sub, Icon and Checkbox(IsCheckVisible).
+ /// </summary>
+ /// <remarks>
+ /// BaseTypeCell is a abstract class inherited from a cell.<br>
+ /// Type1Cell Class and Type2Cell Class are used to inherit this class.<br>
+ /// Properties are used equally and are only slightly different position.<br>
+ /// Each property is displayed in the specified position.<br>
+ /// The specified position is shown below.<br>
+ /// <br>
+ /// Type1Cell
+ /// <table border=2 style="text-align:center;border-collapse:collapse;">
+ /// <tr>
+ /// <th height = 100 width=200 rowspan="2">Icon</th>
+ /// <th width = 150> Text </th>
+ /// <th width = 150>TextEnd</th>
+ /// <th width = 200 rowspan="2">CheckBox</th>
+ /// </tr>
+ /// <tr>
+ /// <th colspan = "2" > Sub </th>
+ /// </tr>
+ /// </table>
+ /// <br>
+ /// Type2Cell
+ /// <table border=2 style="text-align:center;border-collapse:collapse;">
+ /// <tr>
+ /// <th height = 100 width=200 rowspan="2">Icon</th>
+ /// <th colspan = "2" > Sub </th>
+ /// <th width=200 rowspan="2">CheckBox</th>
+ /// </tr>
+ /// <tr>
+ /// <th width = 150> Text </th>
+ /// <th width=150>TextEnd</th>
+ /// </tr>
+ /// </table>
+ /// Type2Cell is almost same with Type1Cell except for the position of sub line.
+ /// </remarks>
public abstract class BaseTypeCell : Cell
{
public static readonly BindableProperty TextProperty = BindableProperty.Create("Text", typeof(string), typeof(BaseTypeCell), default(string));
public static readonly BindableProperty IconHeightProperty = BindableProperty.Create("IconHeight", typeof(int), typeof(MultilineCell), 0);
+ /// <summary>
+ /// BaseTypeCell's constructor
+ /// </summary>
public BaseTypeCell()
{
Disappearing += (sender, e) =>
};
}
+ /// <summary>
+ /// Gets or sets the the Text displayed as the content of Item.
+ /// </summary>
public string Text
{
get { return (string)GetValue(TextProperty); }
set { SetValue(TextProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the the TextEnd displayed as the content of Item.
+ /// </summary>
public string TextEnd
{
get { return (string)GetValue(TextEndProperty); }
set { SetValue(TextEndProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the the Sub displayed as the content of Item.
+ /// </summary>
public string Sub
{
get { return (string)GetValue(SubProperty); }
set { SetValue(SubProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Image on the left side of the item
+ /// </summary>
[TypeConverter(typeof(ImageSourceConverter))]
public ImageSource Icon
{
set { SetValue(IconProperty, value); }
}
+ /// <summary>
+ /// true or false, to indicate whether the checkbox is displayed on the right side of the item
+ /// </summary>
public bool IsCheckVisible
{
get { return (bool)GetValue(IsCheckVisibleProperty); }
set { SetValue(IsCheckVisibleProperty, value); }
}
+ /// <summary>
+ /// true or false, to indicate whether the checkbox has been toggled.
+ /// </summary>
public bool IsChecked
{
get { return (bool)GetValue(IsCheckedProperty); }
set { SetValue(IsCheckedProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Icon's width
+ /// </summary>
public int IconWidth
{
get { return (int)GetValue(IconWidthProperty); }
set { SetValue(IconWidthProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Icon's height
+ /// </summary>
public int IconHeight
{
get { return (int)GetValue(IconHeightProperty); }
set { SetValue(IconHeightProperty, value); }
}
+ /// <summary>
+ /// Event that is raised when checkbox is toggled.
+ /// </summary>
public event EventHandler<ToggledEventArgs> Toggled;
void OnSourcePropertyChanged(ImageSource oldvalue, ImageSource newvalue)
namespace Tizen.Xamarin.Forms.Extension
{
+ /// <summary>
+ /// DoubleLabelCell containing Text, Sub, Icon and End.
+ /// </summary>
+ /// <remarks>
+ /// DoubleLabelCell is a class inherited from a cell.<br>
+ /// Each property is displayed in the specified position.<br>
+ /// The specified position is shown below.<br>
+ /// <br>
+ /// <table border=2 style="text-align:center;border-collapse:collapse;">
+ /// <tr>
+ /// <th height = 100 width=200 rowspan="2">Icon</th>
+ /// <th width=200>Text</th>
+ /// <th width=200 rowspan="2">End</th>
+ /// </tr>
+ /// <tr>
+ /// <th>Sub</th>
+ /// </tr>
+ /// </table>
+ /// </remarks>
+ /// <example>
+ /// <code>
+ /// new DataTemplate(() =>
+ /// {
+ /// return new DoubleLabelCell
+ /// {
+ /// Text = "Test Text",
+ /// Sub = "Test Sub",
+ /// Icon = ImageSource.FromFile("icon.png"),
+ /// End = ImageSource.FromFile("end.png"),
+ /// IconWidth = 80,
+ /// IconHeight = 100,
+ /// EndWidth = 80,
+ /// EndHeight = 100,
+ /// };
+ /// });
+ /// </code>
+ /// </example>
public class DoubleLabelCell : Cell
{
public static readonly BindableProperty TextProperty = BindableProperty.Create("Text", typeof(string), typeof(DoubleLabelCell), default(string));
public static readonly BindableProperty EndHeightProperty = BindableProperty.Create("EndHeight", typeof(int), typeof(DoubleLabelCell), 0);
+ /// <summary>
+ /// MultilineCell's constructor
+ /// </summary>
public DoubleLabelCell()
{
Disappearing += (sender, e) =>
};
}
+ /// <summary>
+ /// Gets or sets the text from the central top of the item
+ /// </summary>
public string Text
{
get { return (string)GetValue(TextProperty); }
set { SetValue(TextProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the sub from the central bottom of the item
+ /// </summary>
public string Sub
{
get { return (string)GetValue(SubProperty); }
set { SetValue(SubProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Image on the left side of the item
+ /// </summary>
[TypeConverter(typeof(ImageSourceConverter))]
public ImageSource Icon
{
set { SetValue(IconProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Icon's width
+ /// </summary>
public int IconWidth
{
get { return (int)GetValue(IconWidthProperty); }
set { SetValue(IconWidthProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Icon's height
+ /// </summary>
public int IconHeight
{
get { return (int)GetValue(IconHeightProperty); }
set { SetValue(IconHeightProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Image on the right side of the item
+ /// </summary>
[TypeConverter(typeof(ImageSourceConverter))]
public ImageSource End
{
set { SetValue(EndProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the End's width
+ /// </summary>
public int EndWidth
{
get { return (int)GetValue(EndWidthProperty); }
set { SetValue(EndWidthProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the End's width
+ /// </summary>
public int EndHeight
{
get { return (int)GetValue(IconHeightProperty); }
namespace Tizen.Xamarin.Forms.Extension
{
+ /// <summary>
+ /// MultilineCell containing Icons, Text, Multiline, and Checkbox(IsCheckVisible).
+ /// </summary>
+ /// <remarks>
+ /// MultilineCell is a class inherited from a cell.<br>
+ /// Each property is displayed in the specified position.<br>
+ /// The specified position is shown below.<br>
+ /// <br>
+ /// <table border=2 style="text-align:center;border-collapse:collapse;">
+ /// <tr>
+ /// <th height = 100 width=200 rowspan="2">Icon</th>
+ /// <th width = 200> Text </th>
+ /// <th width=200 rowspan="2">Checkbox</th>
+ /// </tr>
+ /// <tr>
+ /// <th>Multiline</th>
+ /// </tr>
+ /// </table>
+ /// </remarks>
+ /// <example>
+ /// <code>
+ /// new DataTemplate(() =>
+ /// {
+ /// return new MultilineCell
+ /// {
+ /// Text = "Test Text",
+ /// Multiline = "Test Multiline",
+ /// Icon = ImageSource.FromFile("icon.png"),
+ /// IsCheckVisible = true,
+ /// IconWidth = 80,
+ /// IconHeight = 100,
+ /// };
+ /// });
+ /// </code>
+ /// </example>
public class MultilineCell : Cell
{
public static readonly BindableProperty TextProperty = BindableProperty.Create("Text", typeof(string), typeof(MultilineCell), default(string));
public static readonly BindableProperty IconHeightProperty = BindableProperty.Create("IconHeight", typeof(int), typeof(MultilineCell), 0);
-
+ /// <summary>
+ /// MultilineCell's constructor
+ /// </summary>
public MultilineCell()
{
Disappearing += (sender, e) =>
};
}
+ /// <summary>
+ /// Gets or sets the text from the central top of the item
+ /// </summary>
public string Text
{
get { return (string)GetValue(TextProperty); }
set { SetValue(TextProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Multiline from the central bottom of the item
+ /// </summary>
public string Multiline
{
get { return (string)GetValue(MultilineProperty); }
set { SetValue(MultilineProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Image on the left side of the item
+ /// </summary>
[TypeConverter(typeof(ImageSourceConverter))]
public ImageSource Icon
{
set { SetValue(IconProperty, value); }
}
+ /// <summary>
+ /// true or false, to indicate whether the checkbox is displayed on the right side of the item
+ /// </summary>
public bool IsCheckVisible
{
get { return (bool)GetValue(IsCheckVisibleProperty); }
set { SetValue(IsCheckVisibleProperty, value); }
}
+ /// <summary>
+ /// true or false, to indicate whether the checkbox has been toggled.
+ /// </summary>
public bool IsChecked
{
get { return (bool)GetValue(IsCheckedProperty); }
set { SetValue(IsCheckedProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Icon's width
+ /// </summary>
public int IconWidth
{
get { return (int)GetValue(IconWidthProperty); }
set { SetValue(IconWidthProperty, value); }
}
+ /// <summary>
+ /// Gets or sets the Icon's Height
+ /// </summary>
public int IconHeight
{
get { return (int)GetValue(IconHeightProperty); }
set { SetValue(IconHeightProperty, value); }
}
+ /// <summary>
+ /// Event that is raised when checkbox is toggled.
+ /// </summary>
public event EventHandler<ToggledEventArgs> Toggled;
void OnSourcePropertyChanged(ImageSource oldvalue, ImageSource newvalue)
namespace Tizen.Xamarin.Forms.Extension
{
+ /// <summary>
+ /// Type1Cell is a class inherited from a BaseTypeCell.
+ /// </summary>
+ /// <remarks>
+ /// Each property is displayed in the specified position.<br>
+ /// The specified position is shown below.<br>
+ /// <br>
+ /// <table border=2 style="text-align:center;border-collapse:collapse;">
+ /// <tr>
+ /// <th height = 100 width=200 rowspan="2">Icon</th>
+ /// <th width = 150 > Text </th>
+ /// <th width=150>TextEnd</th>
+ /// <th width = 200 rowspan="2">CheckBox</th>
+ /// </tr>
+ /// <tr>
+ /// <th colspan = "2" > Sub </th>
+ /// </tr>
+ /// </table>
+ /// </remarks>
+ /// <example>
+ /// <code>
+ /// new DataTemplate(() =>
+ /// {
+ /// return new Type1Cell
+ /// {
+ /// Text = "Test Text",
+ /// TextEnd = "TestEnd Text",
+ /// Sub = "Test Sub",
+ /// Icon = ImageSource.FromFile("icon.png"),
+ /// IsCheckVisible = true,
+ /// IconWidth = 80,
+ /// IconHeight = 100,
+ /// };
+ /// });
+ /// </code>
+ /// </example>
public class Type1Cell : BaseTypeCell
{
}
namespace Tizen.Xamarin.Forms.Extension
{
+ /// <summary>
+ /// Type2Cell is a class inherited from a BaseTypeCell.
+ /// </summary>
+ /// <remarks>
+ /// Each property is displayed in the specified position.<br>
+ /// The specified position is shown below.<br>
+ /// <br>
+ /// <table border=2 style="text-align:center;border-collapse:collapse;">
+ /// <tr>
+ /// <th height = 100 width=200 rowspan="2">Icon</th>
+ /// <th colspan = "2" > Sub </th>
+ /// <th width = 200 rowspan="2">CheckBox</th>
+ /// </tr>
+ /// <tr>
+ /// <th width = 150 > Text </th>
+ /// <th width = 150>TextEnd</th>
+ /// </tr>
+ /// </table>
+ /// Type2Cell is almost same with Type1Cell except for the position of sub line.
+ /// </remarks>
+ /// <example>
+ /// <code>
+ /// new DataTemplate(() =>
+ /// {
+ /// return new Type2Cell
+ /// {
+ /// Text = "Test Text",
+ /// TextEnd = "TestEnd Text",
+ /// Sub = "Test Sub",
+ /// Icon = ImageSource.FromFile("icon.png"),
+ /// IsCheckVisible = true,
+ /// IconWidth = 80,
+ /// IconHeight = 100,
+ /// };
+ /// });
+ /// </code>
+ /// </example>
public class Type2Cell : BaseTypeCell
{
}
/// <summary>
/// The RadioButton is a widget that allows for 1 or more options to be displayed and have the user choose only 1 of them.
/// </summary>
+ /// <example>
+ /// <code>
+ /// var radioButton = new RadioButton
+ /// {
+ /// Text = "Radio 1",
+ /// GroupName = "Group 1",
+ /// IsSelected = false,
+ /// }
+ /// radioButton.Selected += (s,e) => { ... };
+ /// </code>
+ /// </example>
public class RadioButton : View
{
- /// <summary>
- /// BindableProperty. Backing store for the Text bindable property.
- /// </summary>
public static readonly BindableProperty TextProperty = BindableProperty.Create("Text", typeof(string), typeof(RadioButton), default(string));
- /// <summary>
- /// BindableProperty. Backing store for the TextColor bindable property.
- /// </summary>
public static readonly BindableProperty TextColorProperty = BindableProperty.Create("TextColor", typeof(Color), typeof(RadioButton), Color.Default);
- /// <summary>
- /// BindableProperty. Backing store for the Font bindable property.
- /// </summary>
public static readonly BindableProperty FontProperty = BindableProperty.Create("Font", typeof(Font), typeof(RadioButton), default(Font),
propertyChanged: FontStructPropertyChanged);
- /// <summary>
- /// BindableProperty. Backing store for the FontFamily bindable property.
- /// </summary>
public static readonly BindableProperty FontFamilyProperty = BindableProperty.Create("FontFamily", typeof(string), typeof(RadioButton), default(string),
propertyChanged: SpecificFontPropertyChanged);
- /// <summary>
- /// BindableProperty. Backing store for the FontSize bindable property.
- /// </summary>
public static readonly BindableProperty FontSizeProperty = BindableProperty.Create("FontSize", typeof(double), typeof(RadioButton), -1.0,
propertyChanged: SpecificFontPropertyChanged,
defaultValueCreator: bindable => Device.GetNamedSize(NamedSize.Default, (RadioButton)bindable));
- /// <summary>
- /// BindableProperty. Backing store for the FontAttributes bindable property.
- /// </summary>
public static readonly BindableProperty FontAttributesProperty = BindableProperty.Create("FontAttributes", typeof(FontAttributes), typeof(RadioButton), FontAttributes.None,
propertyChanged: SpecificFontPropertyChanged);
- /// <summary>
- /// BindableProperty. Backing store for the IsSelected bindable property.
- /// </summary>
public static readonly BindableProperty IsSelectedProperty = BindableProperty.Create("IsSelected", typeof(bool), typeof(RadioButton), false,
propertyChanged: IsSelectedPropertyChanged);
- /// <summary>
- /// BindableProperty. Backing store for the GroupName bindable property.
- /// </summary>
public static readonly BindableProperty GroupNameProperty = BindableProperty.Create("GroupName", typeof(string), typeof(RadioButton), default(string));
/// <summary>
}
/// <summary>
- /// Gets the font family to which the font for the RadioButton text belongs.
+ /// Gets or sets the font family to which the font for the RadioButton text belongs.
/// </summary>
public string FontFamily
{
}
/// <summary>
- /// Gets a value that indicates whether the font for the RadioButton text is bold, italic, or neither.
+ /// Gets or sets a value that indicates whether the font for the RadioButton text is bold, italic, or neither.
/// </summary>
public FontAttributes FontAttributes
{
}
/// <summary>
- /// Gets or sets a Boolean value that indicates whether this RadioButton is Selected.
+ /// Gets or sets a Boolean value that indicates whether this RadioButton is selected.
/// </summary>
public bool IsSelected
{
projects / platform / core / csapi / xamarin-forms-extension.git / commitdiff