Class SfRadialMenu
RadialMenu is a Windows.Windows.Controls.ItemsControl that enables you to hierarchically organize elements in circular layout optimized for touch devices. Typically used as a context menu, it can expose more menu items in the same space than traditional menus.
Inheritance
Implements
Namespace: Syncfusion.Windows.Controls.Navigation
Assembly: Syncfusion.SfRadialMenu.Wpf.dll
Syntax
public class SfRadialMenu : ItemsControl, IDisposable
Constructors
SfRadialMenu()
Initializes a new instance of the SfRadialMenu class.
Declaration
public SfRadialMenu()
See Also
Fields
CenterBackButtonForegroundProperty
Identifies CenterBackButtonForeground property. Using this property, You can change the center back button foreground in SfRadialMenu
Declaration
public static readonly DependencyProperty CenterBackButtonForegroundProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
CenterRimRadiusFactorProperty
Identifies CenterRimRadiusFactor property. Using this property, You can give the center rim radius in SfRadialMenu
Declaration
public static readonly DependencyProperty CenterRimRadiusFactorProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
CommandPathProperty
Identifies CommandPath property. Using this property, You can change the command path in SfRadialMenu
Declaration
public static readonly DependencyProperty CommandPathProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
DisplayMemberPathProperty
Using a DependencyProperty as the backing store for DisplayMemberPath.This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty DisplayMemberPathProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
DrillDownItemProperty
Identifies DrillDownItem property. Using this property, You can change the drill down item in SfRadialMenu
Declaration
public static readonly DependencyProperty DrillDownItemProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
EnableFreeRotationProperty
Identifies EnableFreeRotation property. It indicates whether enable free rotation when the mouse is rotated in SfRadialMenu
Declaration
public static readonly DependencyProperty EnableFreeRotationProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
IconProperty
Identifies Icon property. Using this property, you can give the icon in SfRadialMenu
Declaration
public static readonly DependencyProperty IconProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
IsOpenProperty
Using a DependencyProperty as the backing store for IsOpen. This enables animation, styling, binding, etc...
Declaration
public static readonly DependencyProperty IsOpenProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
LayoutTypeProperty
Identifies LayoutType property. Using this property, you can change the layout type of SfRadialMenu
Declaration
public static readonly DependencyProperty LayoutTypeProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
MouseOverRimStrokeThicknessProperty
Declaration
public static readonly DependencyProperty MouseOverRimStrokeThicknessProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
MouseOverRimStyleProperty
Identifies MouseOverRimStyle property. This style has applied when mouse over on rim of SfRadialMenu
Declaration
public static readonly DependencyProperty MouseOverRimStyleProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
NavigationButtonStyleProperty
Identifies NavigationButtonStyle property. Using this property, You can change the style of navigation button in SfRadialMenu
Declaration
public static readonly DependencyProperty NavigationButtonStyleProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RadiusXProperty
Identifies RadiusX property. Using this property, you can change the radius y in SfRadialMenu
Declaration
public static readonly DependencyProperty RadiusXProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RadiusYProperty
Identifies RadiusY property. Using this property, you can change the radius y in SfRadialMenu
Declaration
public static readonly DependencyProperty RadiusYProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RimActiveBrushProperty
Identifies RimActiveBrush property. Using this property, You can change the rim active brush in SfRadialMenu
Declaration
public static readonly DependencyProperty RimActiveBrushProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RimBackgroundProperty
Identifies RimBackground property. Using this property, You can change the backgroun color of rim in SfRadialMenu
Declaration
public static readonly DependencyProperty RimBackgroundProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RimHoverBrushProperty
Identifies RimHoverBrush property. Using this property, You can change the rim hover brush in SfRadialMenu
Declaration
public static readonly DependencyProperty RimHoverBrushProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
RimRadiusFactorProperty
Identifies RimRadiusFactor property. Using this property, You can change the rim radius of SfRadialMenu
Declaration
public static readonly DependencyProperty RimRadiusFactorProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SeparatorBackgroundProperty
Identifies SeparatorBackground property. Using this property, You can change the background color of separator in SfRadialMenu
Declaration
public static readonly DependencyProperty SeparatorBackgroundProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
SeparatorWidthProperty
Identifies SeparatorWidth property. Using this property, You can change the width of separator in SfRadialMenu
Declaration
public static readonly DependencyProperty SeparatorWidthProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
StrokeThicknessProperty
Identifies StrokeThickness property. Using this property, You can change the thickness of inner rim in SfRadialMenu
Declaration
public static readonly DependencyProperty StrokeThicknessProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
VisibleSegmentsCountProperty
Identifies VisibleSegmentsCount property. It determines the number of items to be displayed in SfRadialMenu
Declaration
public static readonly DependencyProperty VisibleSegmentsCountProperty
Field Value
| Type |
|---|
| System.Windows.DependencyProperty |
Properties
CenterBackButtonForeground
Gets or sets the CenterBackButtonForeground property.
Declaration
public Brush CenterBackButtonForeground { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
CenterRimRadiusFactor
Gets or sets a value of the Radius of the center rim in
Declaration
public double CenterRimRadiusFactor { get; set; }
Property Value
| Type |
|---|
| System.Double |
CommandPath
Gets or sets a path for the command in
Declaration
public string CommandPath { get; set; }
Property Value
| Type |
|---|
| System.String |
DisplayMemberPath
Gets or sets the name or path of the property that is displayed for each data item.
Declaration
public string DisplayMemberPath { get; set; }
Property Value
| Type |
|---|
| System.String |
DrillDownItem
Gets a value of the drill down item.
Declaration
public ItemsControl DrillDownItem { get; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Controls.ItemsControl | The default value is Windows.UI.Xaml.Controls.ItemsControl. |
EnableFreeRotation
Gets or sets a value indicating whether enable free rotation when the mouse is rotated.
Declaration
public bool EnableFreeRotation { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
Icon
Gets or sets a value of the icon that appears in a Syncfusion.UI.Xaml.Controls.Navigation.RadialMenu.
Declaration
public object Icon { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null. |
Remarks
Used to customize the icon displayed in the center of RadialMenuCircle.
IsOpen
Gets or sets a value indicating whether this instance is open in
Declaration
public bool IsOpen { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
LayoutType
Gets or sets a value of the LayoutType
Declaration
public LayoutType LayoutType { get; set; }
Property Value
| Type |
|---|
| LayoutType |
MouseOverRimStrokeThickness
Gets a value indicating whether the width of the radial menu stroke outline with Syncfusion.UI.Xaml.Controls.Navigation.RadialMenu.
Declaration
public double MouseOverRimStrokeThickness { get; }
Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 100. |
Remarks
Used to set the circle stroke thickness.
MouseOverRimStyle
Gets or sets a value of style for the mouse over rim in
Declaration
public Style MouseOverRimStyle { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Style | The default value is null. |
NavigationButtonStyle
Gets or sets a value of the style for the navigation button in
Declaration
public Style NavigationButtonStyle { get; set; }
Property Value
| Type |
|---|
| System.Windows.Style |
RadiusX
Gets or sets a value of the radius X for Syncfusion.UI.Xaml.Controls.Navigation.RadialMenu.
Declaration
public double RadiusX { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Double | The default value is zero. |
Remarks
Used to define the x radius value of the circle.
See Also
RadiusY
Gets or sets the radius Y for Syncfusion.UI.Xaml.Controls.Navigation.RadialMenu.
Declaration
public double RadiusY { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Double | The default is zero. |
Remarks
Used to define the y radius value of the circle
See Also
RimActiveBrush
Gets or sets a value of the Active brush of the rim in
Declaration
public Brush RimActiveBrush { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
RimBackground
Gets or sets the background brush for the Rim in
Declaration
public Brush RimBackground { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Windows.Media.Brush | The default value is null. |
RimHoverBrush
Gets or sets a value of the Hover brush of the rim in
Declaration
public Brush RimHoverBrush { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
RimRadiusFactor
Gets or sets a value of the Radius of the rim in
Declaration
public double RimRadiusFactor { get; set; }
Property Value
| Type |
|---|
| System.Double |
SeparatorBackground
Gets or sets a value of the background for the RadialMenuSeparator in
Declaration
public Brush SeparatorBackground { get; set; }
Property Value
| Type |
|---|
| System.Windows.Media.Brush |
SeparatorWidth
Gets or sets a value of the width for the RadialMenuSeparator in
Declaration
public double SeparatorWidth { get; set; }
Property Value
| Type |
|---|
| System.Double |
StrokeThickness
Gets a value indicating whether the width of the radial menu stroke outline with Syncfusion.UI.Xaml.Controls.Navigation.RadialMenu.
Declaration
public double StrokeThickness { get; }
Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 25. |
Remarks
Used to set the circle stroke thickness.
VisibleSegmentsCount
Gets or sets a value of the maximum number of items that can be displayed in all the hierarchy levels of menu
Declaration
public int VisibleSegmentsCount { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
Methods
Close()
The method used to close the Syncfusion.UI.Xaml.Controls.Navigation.RadialMenu.
Declaration
public void Close()
Remarks
The Return value is void.
See Also
Dispose()
Represents dispose method for disposing unwanted objects
Declaration
public void Dispose()
Dispose(Boolean)
Dispose all the instances using in RadialMenu
Declaration
protected virtual void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing | variable to indicate whether the items can be disposable or not |
OnApplyTemplate()
Initializes the variables on applying the template
Declaration
public override void OnApplyTemplate()
OnItemsChanged(NotifyCollectionChangedEventArgs)
Called when the items has been modified by the user
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Specialized.NotifyCollectionChangedEventArgs | e | The event arguments |
OnManipulationCompleted(ManipulationCompletedEventArgs)
Called when the event is hooked
Declaration
protected override void OnManipulationCompleted(ManipulationCompletedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.ManipulationCompletedEventArgs | e | the event arguments |
OnManipulationDelta(ManipulationDeltaEventArgs)
Called when the event is hooked. Sets the angle for the control.
Declaration
protected override void OnManipulationDelta(ManipulationDeltaEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.ManipulationDeltaEventArgs | e | the event arguments |
OnManipulationStarted(ManipulationStartedEventArgs)
Called when the event is hooked
Declaration
protected override void OnManipulationStarted(ManipulationStartedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.ManipulationStartedEventArgs | e | the event arguments |
OnMouseLeftButtonUp(MouseButtonEventArgs)
Occurs when the focus is obtained
Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseButtonEventArgs | e | event arguments |
OnMouseMove(MouseEventArgs)
Occurs when the mouse input is moved
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.MouseEventArgs | e | event arguments |
Show()
The method used to show the Syncfusion.UI.Xaml.Controls.Navigation.RadialMenu.
Declaration
public void Show()
Remarks
The Return value is void.
See Also
Events
Closed
Calls the event when the control is closed.
Declaration
public event RoutedEventHandler Closed
Event Type
| Type |
|---|
| System.Windows.RoutedEventHandler |
Navigating
Event to notify user when navigation is being started
Declaration
public event NavigatingEventHandler Navigating
Event Type
| Type |
|---|
| NavigatingEventHandler |
Opened
Calls the event when the control is open.
Declaration
public event RoutedEventHandler Opened
Event Type
| Type |
|---|
| System.Windows.RoutedEventHandler |