Class SfRadialMenuItem

Represents an item that can be added as children in SfRadialMenu.Any object can be added as SfRadialMenuItem and that can be populated as menus.

Inheritance

System.Object

SfRadialMenuItem

Namespace: Syncfusion.SfRadialMenu.XForms

Assembly: Syncfusion.SfRadialMenu.XForms.dll

Syntax

public class SfRadialMenuItem : View, IThemeElement

Constructors

SfRadialMenuItem()

Initializes a new instance of the SfRadialMenuItem class.

Declaration

public SfRadialMenuItem()

Fields

BackgroundColorProperty

Identifies the BackgroundColor bindable property. It indicates the back color of item. It will not be applicable to custom view.

Declaration

public static readonly BindableProperty BackgroundColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

BackgroundImageProperty

Identifies the BackgroundImage bindable property. It indicates an image that loads on item. Users can directly load an image instead of custom view.

Declaration

public static readonly BindableProperty BackgroundImageProperty

Field Value

Type
Xamarin.Forms.BindableProperty

CommandParameterProperty

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

Declaration

public static readonly BindableProperty CommandParameterProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Remarks

This bindable property is read-only.

CommandProperty

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

Declaration

public static readonly BindableProperty CommandProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontAttributesProperty

Identifies the FontSize bindable property. It indicates attributes of caption text of item. It will not be applicable to custom view.

Declaration

public static readonly BindableProperty FontAttributesProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontFamilyProperty

Identifies the FontFamily bindable property. It indicates the font family of caption text item.

Declaration

public static readonly BindableProperty FontFamilyProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontIconTextProperty

Identifies the FontIconText bindable property. It indicates the text of font icon in SfRadialMenu.

Declaration

public static readonly BindableProperty FontIconTextProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontSizeProperty

Identifies the FontSize bindable property. It indicates the size of caption text of item. It will not be applicable to custom view.

Declaration

public static readonly BindableProperty FontSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IconFontColorProperty

Identifies the IconFontColor bindable property. It indicates the color of the font icon text in SfRadialMenu.

Declaration

public static readonly BindableProperty IconFontColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IconFontFamilyProperty

Identifies the IconFontFamily bindable property. This property can be used to change the value of the font family of font icon.

Declaration

public static readonly BindableProperty IconFontFamilyProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IconFontSizeProperty

Identifies the IconFontSize bindable property. This property can be used to change the size of the font icon in SfRadialMenuItem.

Declaration

public static readonly BindableProperty IconFontSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ImageProperty

Identifies the Image bindable property. It indicates an image that loads on item. Users can directly load an image instead of custom view.

Declaration

public static readonly BindableProperty ImageProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ItemHeightProperty

Identifies the ItemHeight bindable property. This property can be used to customize the height of the items.

Declaration

public static readonly BindableProperty ItemHeightProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ItemsProperty

Identifies the Items bindable property. It represents a list of items to display in SfRadialMenuItem.

Declaration

public static readonly BindableProperty ItemsProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ItemWidthProperty

Identifies the ItemWidth bindable property. This property can be used to customize the width of items.

Declaration

public static readonly BindableProperty ItemWidthProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SegmentIndexProperty

Identifies the SegmentIndex bindable property. This value allows user to rearrange or position the items.

Declaration

public static readonly BindableProperty SegmentIndexProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TextColorProperty

Identifies the TextColor bindable property. It indicates the color of caption text of item.

Declaration

public static readonly BindableProperty TextColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TextProperty

Identifies the Text bindable property. It indicates caption text of the item. It will not be applicable to custom view.

Declaration

public static readonly BindableProperty TextProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ViewProperty

Identifies the View bindable property. It indicates a view placed on it. Any view can be assigned on the item.

Declaration

public static readonly BindableProperty ViewProperty

Field Value

Type
Xamarin.Forms.BindableProperty

VisibleSegmentsCountProperty

Identifies the VisibleSegmentsCount bindable property. This value that splits the available spaces as pie segments.

Declaration

public static readonly BindableProperty VisibleSegmentsCountProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Properties

BackgroundColor

Gets or sets the value indicating the back color of the item. It will not applicable to custom view.

Declaration

public Color BackgroundColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The default value is transparent.

BackgroundImage

Gets or sets the value indicating image that load on the item. Users can directly load an image instead of custom view.

Declaration

public string BackgroundImage { get; set; }

Property Value

Type	Description
System.String	The default value is string.Empty.

Command

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

Declaration

public ICommand Command { get; set; }

Property Value

Type
System.Windows.Input.ICommand

CommandParameter

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

Declaration

public object CommandParameter { get; set; }

Property Value

Type	Description
System.Object	The command parameter.

FontAttributes

Gets or sets the value indicating attributes of the caption text of the item. It will not applicable to custom view.

Declaration

public FontAttributes FontAttributes { get; set; }

Property Value

Type	Description
Xamarin.Forms.FontAttributes	The default font attribute is none.

FontFamily

Gets or sets the value that indicating the font family of the caption text item. It will not applicable to custom view.

Declaration

public string FontFamily { get; set; }

Property Value

Type	Description
System.String	The default font family is string.Empty.

FontIconText

Gets or sets the value of FontIconText. It indicates the text of the font icon in SfRadialMenu.

Declaration

public string FontIconText { get; set; }

Property Value

Type	Description
System.String	The default value is string.Empty.

Type	Description
System.Double	The default text size is 20.

IconFontColor

Gets or sets the value of IconFontColor. It indicates the color of the font icon text in SfRadialMenu.

Declaration

public Color IconFontColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The default value is black.

IconFontFamily

Gets or sets the value of IconFontFamily. This property can be used to change the value of font family of font icon.

Declaration

public string IconFontFamily { get; set; }

Property Value

Type	Description
System.String	The default value is empty.

IconFontSize

Gets or sets the value of FontIconSize. This property can be used to change the size of the font icon in SfRadialMenuItem.

Declaration

public double IconFontSize { get; set; }

Property Value

Type	Description
System.Double	The default value is 20.

Image

Gets or sets the value indicating image that load on the item. Users can directly load an image instead of custom view.

Declaration

public string Image { get; set; }

Property Value

Type	Description
System.String	The default value is string.Empty.

ItemHeight

Gets or sets the value of ItemHeight. This property can be used to customize the height of the items.

Declaration

public double ItemHeight { get; set; }

Property Value

Type	Description
System.Double	The default value is 90.

Items

Gets or sets the value of Items. It represents a list of items to display in SfRadialMenuItem.

Declaration

public ObservableCollection<SfRadialMenuItem> Items { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<SfRadialMenuItem>	The default value is null.

ItemWidth

Gets or sets the value of ItemWidth. This property can be used to customize the width of items.

Declaration

public double ItemWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is 90.

SegmentIndex

Gets or sets the value that allows user to rearrange or position the items. It will be applicable only if the SfRadialMenu in Custom layout type.

Declaration

public int SegmentIndex { get; set; }

Property Value

Type	Description
System.Int32	The default value is -1.

Text

Gets or sets the value indicating caption text of the item. It will not applicable to custom view.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	The default value is string.Empty.

TextColor

Gets or sets the value indicating color of the caption text of the item. It will not applicable to custom view.

Declaration

public Color TextColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The default value is black.

View

Gets or sets the value indicating a view that placed on it . Any view can be assigned on the item.

Declaration

public View View { get; set; }

Property Value

Type	Description
Xamarin.Forms.View	The default value is null.

VisibleSegmentsCount

Gets or sets the value that splits the available spaces as pie segments. Exceeded items will not shown and beneath items leave empty space on rim. It will be applicable only if the SfRadialMenu in Custom layout type.

Declaration

public int VisibleSegmentsCount { get; set; }

Property Value

Type	Description
System.Int32	The default value is 10.

Methods

add_ItemTapped(SfRadialMenuItem.ItemTappedEventHandler)

Declaration

public void add_ItemTapped(SfRadialMenuItem.ItemTappedEventHandler value)

Parameters

Type	Name	Description
SfRadialMenuItem.ItemTappedEventHandler	value

remove_ItemTapped(SfRadialMenuItem.ItemTappedEventHandler)

Declaration

public void remove_ItemTapped(SfRadialMenuItem.ItemTappedEventHandler value)

Parameters

Type	Name	Description
SfRadialMenuItem.ItemTappedEventHandler	value

Events

ItemTapped

Occurs when a RadialMenuItem is tapped. Item can be retrieved and customized in SfRadialMenu.

Declaration

public event SfRadialMenuItem.ItemTappedEventHandler ItemTapped

Event Type

Type
SfRadialMenuItem.ItemTappedEventHandler