namespace Tizen.Xamarin.Forms.Extension
{
/// <summary>
- /// The FloatingButton class
+ /// The FloatingButton class.
/// This is only supported for mobile profiles.
/// </summary>
/// <example>
}
/// <summary>
- /// Gets the horizontal position of the FloatingButton. This is a bindable property
+ /// Gets the horizontal position of the FloatingButton. This is a bindable property.
/// </summary>
public FloatingButtonPosition Position
{
}
/// <summary>
- /// Gets and sets the internal button of the FloatingButton
+ /// Gets and sets the internal button of the FloatingButton.
/// </summary>
public FloatingButtonItem FirstButton
{
}
/// <summary>
- /// Gets and sets the internal button of the FloatingButton
+ /// Gets and sets the internal button of the FloatingButton.
/// </summary>
public FloatingButtonItem SecondButton
{
/// <summary>
/// Sets the horizontal position of the FloatingButton.
/// </summary>
- /// <param name="position"> FloatingButtonPosition value </param>
- /// <param name="animated"> Bool value to set the animation when moving the position </param>
+ /// <param name="position"> The destination position of the FloatingButton. </param>
+ /// <param name="animated"> Set the animation when moving the position. </param>
public void SetPosition(FloatingButtonPosition position, bool animated)
{
if (MovablePosition != FloatingButtonMovablePosition.None)
}
/// <summary>
- /// A method to hide the FloatingButton
+ /// A method to hide the FloatingButton.
/// </summary>
public void Hide()
{
}
/// <summary>
- /// A method to show the FloatingButton
+ /// A method to show the FloatingButton.
/// </summary>
public void Show()
{
public FloatingButton()
{
if (Device.Idiom != TargetIdiom.Phone)
- throw new Exception("FloatingButton is support only mobile profile.");
+ throw new Exception("FloatingButton is only support mobile profiles.");
_floatingButton = DependencyService.Get<IFloatingButton>(DependencyFetchTarget.GlobalInstance);
namespace Tizen.Xamarin.Forms.Extension
{
/// <summary>
- /// A class for containing icons and event information
+ /// The FloatingButtonItem class for containing icons and event information.
/// </summary>
public class FloatingButtonItem
{
}
/// <summary>
- /// Gets or sets the Icon of the FloatingButtonItem
+ /// Gets or sets the Icon of the FloatingButtonItem.
/// </summary>
public FileImageSource Icon
{
}
/// <summary>
- /// Occurs when the FloatingButtonItem clicked
+ /// Occurs when the FloatingButtonItem clicked.
/// </summary>
public event EventHandler Clicked;
namespace Tizen.Xamarin.Forms.Extension
{
/// <summary>
- /// Enumerates values that describe the Mode of FloatingButton.
+ /// Enumerates values that describe the MovablePosition of FloatingButton.
/// </summary>
public enum FloatingButtonMovablePosition
{
/// <summary>
- /// allows all positions
+ /// Allows the FloatingButton can be placed in all FloatingButtonPosition.
/// </summary>
All,
/// <summary>
- /// allows LEFT and RIGHT positions only
+ /// Allows the FloatingButton can be placed in only LEFT and RIGHT FloatingButtonPosition.
/// </summary>
LeftRightOnly,
/// <summary>
- /// movement blocked
+ /// Blocks movement of the FloatingButton.
/// </summary>
None,
}