Class SfButton

Represents the SfButton class.

Inheritance

Inherited Members

public class SfButton : SfBorder, IParentThemeElement, IThemeElement

Initializes a new instance of the SfButton class. It is a constructor field.

public SfButton()

Identifies the BackgroundColor property. This property can be used to change the background color of the SfButton control.

public static readonly BindableProperty BackgroundColorProperty

This Xamarin.Forms.BindableProperty is read-only.

Gets or sets the gradient background color for button.

public static readonly BindableProperty BackgroundGradientProperty

Identifies the BackgroundImage property. This property can be used to set an image as the background of SfButton.

public static readonly BindableProperty BackgroundImageProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the BorderColor property. This property can be used to change the border color of the SfButton control.

public static readonly BindableProperty BorderColorProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the BorderWidth property. This property can be used to customize the width of SfBorder.

public static readonly BindableProperty BorderWidthProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the CommandParameter bindable property. It is a parameter to pass to the Command property. This is a bindable property.

public static readonly BindableProperty CommandParameterProperty

This bindable property is read-only.

Identifies the Command bindable property. It invokes when the button is activated. The default value is null.

public static readonly BindableProperty CommandProperty

This bindable property is read-only.

Identifies the Content property. This property can be used to set custom view to the button control.

public static readonly BindableProperty ContentProperty

This bindable property is read-only.

Identifies the EnableRippleEffect property. This property can be used to enable ripple effect of button.

public static readonly BindableProperty EnableRippleEffectProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the FontAttributes property. This property can be used to change the font of text to either bold or italic.

public static readonly BindableProperty FontAttributesProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the FontFamily property. This property can be used to change the font family of the text in button.

public static readonly BindableProperty FontFamilyProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the FontSize property. This property can be used to change the font size of the text in button.

public static readonly BindableProperty FontSizeProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the HorizontalTextAlignment property. This property can be used to change the horizontal position of text in SfButton.

public static readonly BindableProperty HorizontalTextAlignmentProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the ImageAlignment property. This property can be used to change the position of the image in the button control.

public static readonly BindableProperty ImageAlignmentProperty

This Xamarin.Forms.BindableProperty is read-only.

Gets or sets a value of the Image. This property can be used to customize the image of the button.

public static readonly BindableProperty ImageProperty

Identifies the ImageSource property. This property can be used to set an image to the background of the button.

public static readonly BindableProperty ImageSourceProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the ImageWidth bindable property. This property can be used to customize the width of an imgage in the button control.

public static readonly BindableProperty ImageWidthProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the IsCheckable property. This property can be used to change the state of the button.

public static readonly BindableProperty IsCheckableProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the IsChecked property. It indicates whether the button is in the default state in SfButton.

public static readonly BindableProperty IsCheckedProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the Padding property. This property can be used to set padding to the sides of button.

public static readonly BindableProperty PaddingProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the PressedBackgroundColor property. This property can be used to change the background color of button when clicking.

public static readonly BindableProperty PressedBackgroundColorProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the ShowIcon property. This property can be used to set an icon by setting this property to true.

public static readonly BindableProperty ShowIconProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the TextColor property. This property can be used to change the color of text in the SfButton control.

public static readonly BindableProperty TextColorProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the Text property. This property can be used to set text property to the button control.

public static readonly BindableProperty TextProperty

This Xamarin.Forms.BindableProperty is read-only.

Identifies the VerticalTextAlignment property. This property can be used to change the vertical position of text in SfButton.

public static readonly BindableProperty VerticalTextAlignmentProperty

This Xamarin.Forms.BindableProperty is read-only.

Gets or sets the value of the BackgroundColor. This property can be used to change the background color of the SfButton control.

public Color BackgroundColor { get; set; }

Gets or sets the gradient background color for button.

public SfGradientBrush BackgroundGradient { get; set; }

Gets or sets the value of the BackgroundImage. This property can be used to set an image as the background of SfButton.

public ImageSource BackgroundImage { get; set; }

Gets or sets the value of the BorderColor. This property can be used to change the border color of the SfButton control.

public Color BorderColor { get; set; }

Gets or sets the value of the BorderWidth. This property can be used to customize the width of the SfBorder control.

public double BorderWidth { get; set; }

Gets or sets the value of the Command. It invokes when the button is activated. It is a bindale property.

public ICommand Command { get; set; }

Gets or sets the value of the CommandParameter, which is a parameter to pass the Command property. This is a bindable property.

public object CommandParameter { get; set; }

Gets or sets the value of the Content. This property can be used to set custom view to the button control.

public View Content { get; set; }

Gets or sets a value indicating whether the ripple effect of SfButton is enabled or not.

public bool EnableRippleEffect { get; set; }

This property is not supported for UWP and WPF platforms.

Gets or sets the value of FontAttributes. This property can be used to change the font of text in either bold or italic.

public FontAttributes FontAttributes { get; set; }

Gets or sets the value of the FontFamily. This property can be used to change the font family of the text in button.

public string FontFamily { get; set; }

Gets or sets the value of FontSize. This property can be used to change the font size of the text in button.

public double FontSize { get; set; }

Gets or sets the value of the HorizontalTextAlignment. This property can be used to change the horizontal position of text in SfButton.

public TextAlignment HorizontalTextAlignment { get; set; }

Gets or sets a value of the Image. This property can be used to customize the image of the button.

public Image Image { get; set; }

Gets or sets the value of the ImageAlignment. This property can be used to set padding to the sides of the button.

public Alignment ImageAlignment { get; set; }

Gets or sets a value of the ImageSoure. This property can be used to set the image to the background of the button.

public ImageSource ImageSource { get; set; }

Gets or sets the value of the width of image icon. This property can be used to customize the width of the Image in button.

public int ImageWidth { get; set; }

Gets or sets a value indicating whether the button is in the default state or not. This property can be used to change the state of the button.

public bool IsCheckable { get; set; }

Gets or sets a value indicating whether the button is checkable. It is used to check the state of the button.

public bool IsChecked { get; set; }

Gets or sets the value of Padding. This property can be used to set padding to the sides of button.

public Thickness Padding { get; set; }

Gets or sets the value of the PressedBackgroundColor. This property can be used to change the background color of button when clicking.

public Color PressedBackgroundColor { get; set; }

Gets or sets a value indicating whether the image icon of SfButton is visible or not. The icon is in visible state when this property is set to true.

public bool ShowIcon { get; set; }

Gets or sets a value of the text. This property can be used to set the text input to SfButton.

public string Text { get; set; }

Gets or sets the value of TextColor. This property can be used to change the color of text in the SfButton control.

public Color TextColor { get; set; }

Gets or sets the value of the VerticalTextAlignment. This property can be used to change the vertical position of text in SfButton.

public TextAlignment VerticalTextAlignment { get; set; }

Method is called when a layout measurement happens.

protected override SizeRequest OnMeasure(double widthConstraint, double heightConstraint)

This method calls on every property changed.

protected override void OnPropertyChanged(string propertyName = null)

It represents the Clicked event handler. This clicked event is hooked when clicking the SfButton control.

public event EventHandler<EventArgs> Clicked