ClassRadRadialMenu
Represents a radial menu control that allows users to interact with a set of commands arranged in a circular layout. This control can be customized with various options and is often used for providing quick access to frequently used functions or commands in an application.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.Navigation.dll
Syntax:
[Bindable(BindableSupport.Default)]
[TelerikToolboxCategory("Navigation")]
public class RadRadialMenu : Control, INotifyPropertyChanged
Inheritance: objectRadRadialMenu
Implements:
Constructors
RadRadialMenu()
Initializes a new instance of the RadRadialMenu class.
Declaration
public RadRadialMenu()
Fields
AutoCalculateStartAngleProperty
Identifies the AutoCalculateStartAngle dependency property.
Declaration
public static readonly DependencyProperty AutoCalculateStartAngleProperty
Field Value
DependencyProperty
AutoSizeMenuItemsProperty
Identifies the AutoSizeMenuItems dependency property.
Declaration
public static readonly DependencyProperty AutoSizeMenuItemsProperty
Field Value
DependencyProperty
ClosedEvent
Identifies the Closed routed event.
Declaration
public static readonly RoutedEvent ClosedEvent
Field Value
RoutedEvent
ContentMenuBackgroundStyleProperty
Identifies the ContentMenuBackgroundStyle dependency property.
Declaration
public static readonly DependencyProperty ContentMenuBackgroundStyleProperty
Field Value
DependencyProperty
HideEventNameProperty
Identifies the HideEventName dependency property.
Declaration
public static readonly DependencyProperty HideEventNameProperty
Field Value
DependencyProperty
InnerNavigationRadiusFactorProperty
Identifies the InnerNavigationRadiusFactor dependency property.
Declaration
public static readonly DependencyProperty InnerNavigationRadiusFactorProperty
Field Value
DependencyProperty
InnerRadiusFactorProperty
Identifies the InnerRadiusFactor dependency property.
Declaration
public static readonly DependencyProperty InnerRadiusFactorProperty
Field Value
DependencyProperty
IsOpenProperty
Identifies the IsOpen dependency property.
Declaration
public static readonly DependencyProperty IsOpenProperty
Field Value
DependencyProperty
ItemsSourceProperty
Identifies the ItemsSource dependency property.
Declaration
public static readonly DependencyProperty ItemsSourceProperty
Field Value
DependencyProperty
NavigatedEvent
Identifies the Navigate routed event.
Declaration
public static readonly RoutedEvent NavigatedEvent
Field Value
RoutedEvent
NavigationMenuBackgroundStyleProperty
Identifies the NavigationMenuBackgroundStyle dependency property.
Declaration
public static readonly DependencyProperty NavigationMenuBackgroundStyleProperty
Field Value
DependencyProperty
OpenedEvent
Identifies the Opened routed event.
Declaration
public static readonly RoutedEvent OpenedEvent
Field Value
RoutedEvent
OpeningEvent
Identifies the Opening routed event.
Declaration
public static readonly RoutedEvent OpeningEvent
Field Value
RoutedEvent
OuterBorderPaddingProperty
Identifies the PlacementMode dependency property.
Declaration
public static readonly DependencyProperty OuterBorderPaddingProperty
Field Value
DependencyProperty
OuterRadiusFactorProperty
Identifies the OuterRadiusFactor dependency property.
Declaration
public static readonly DependencyProperty OuterRadiusFactorProperty
Field Value
DependencyProperty
PopupHorizontalOffsetProperty
Identifies the PlacementMode dependency property.
Declaration
public static readonly DependencyProperty PopupHorizontalOffsetProperty
Field Value
DependencyProperty
PopupPlacementProperty
Identifies the PlacementMode dependency property.
Declaration
public static readonly DependencyProperty PopupPlacementProperty
Field Value
DependencyProperty
PopupVerticalOffsetProperty
Identifies the PlacementMode dependency property.
Declaration
public static readonly DependencyProperty PopupVerticalOffsetProperty
Field Value
DependencyProperty
PreviewToolTipOpenEvent
Identifies the PreviewToolTipOpen routed event.
Declaration
public static readonly RoutedEvent PreviewToolTipOpenEvent
Field Value
RoutedEvent
RadialContextMenuProperty
Identifies the RadRadialMenu attached property.
Declaration
public static readonly DependencyProperty RadialContextMenuProperty
Field Value
DependencyProperty
ShowEventNameProperty
Identifies the ShowEventName dependency property.
Declaration
public static readonly DependencyProperty ShowEventNameProperty
Field Value
DependencyProperty
ShowToolTipProperty
Identifies the ShowToolTip dependency property.
Declaration
public static readonly DependencyProperty ShowToolTipProperty
Field Value
DependencyProperty
StartAngleProperty
Identifies the StartAngle dependency property.
Declaration
public static readonly DependencyProperty StartAngleProperty
Field Value
DependencyProperty
StaysOpenOnShowProperty
Identifies the StaysOpenOnShow dependency property.
Declaration
public static readonly DependencyProperty StaysOpenOnShowProperty
Field Value
DependencyProperty
Properties
AnimationSpeedFactor
Gets or sets the speed factor for the animations in RadRadialMenu. The default value is 1.5d. The value is always a positive number. The min value is 0.1d.
Declaration
public static double AnimationSpeedFactor { get; set; }
Property Value
AutoCalculateStartAngle
Gets or sets a value that indicates whether the start angle of the first menu item should be calculated automatically. If set to false the StartAngle property will be used to determine the starting position of the first menu item. This property only works when AutoSizeMenuItems is set to true.
AutoSizeMenuItems
Gets or sets whether the menu items would be auto sized to fill the whole circle of the menu. Setting this property to true allows you to add more than 8 menu items.
CommandService
Gets the CommandService instance that manages the commanding behavior of this instance.
Declaration
public CommandService CommandService { get; }
Property Value
Commands
Gets the collection with all the custom commands registered with the CommandService.
Declaration
public CommandCollection<RadRadialMenu> Commands { get; }
Property Value
Remarks
Custom commands have higher priority than the built-in (default) ones.
ContentMenuBackgroundStyle
Gets or sets the Style value that defines the appearance of the menu items panel.
Declaration
public Style ContentMenuBackgroundStyle { get; set; }
Property Value
Style
Remarks
The Style should target the Rectangle type.
EnableQuickMode
Sets or gets whether the RadRadialMenu is in quick mode. If true, the animation is disabled and the control doesn't close when hiding.
HideEventName
Gets or sets the name of the event that will hide the context menu.
Declaration
public string HideEventName { get; set; }
Property Value
The name of the event.
InnerNavigationRadiusFactor
Gets or sets the factor that defines the inner radius of the panel holding the NavigationItemButton items as a fraction of the size of the RadRadialMenu control.
Declaration
public double InnerNavigationRadiusFactor { get; set; }
Property Value
The value should be between 0 and 1. If the passed value lies outside this range, it is automatically set to the nearest boundary value.
InnerRadiusFactor
Gets or sets the factor that defines the inner radius of the panel holding the RadRadialMenuItem items as a fraction of the size of the RadRadialMenu control.
Declaration
public double InnerRadiusFactor { get; set; }
Property Value
The value should be between 0 and 1. If the passed value lies outside this range, it is automatically set to the nearest boundary value.
IsOpen
Gets or sets a value that indicates whether the RadRadialMenu is open.
IsTemplateApplied
Determines whether the OnApplyTemplate() method and the ApplyTemplateCore() routine is passed.
ItemContainerGenerator
Gets the RadialMenuItemContainerGenerator of the RadRadialMenu
Declaration
public RadialMenuItemContainerGenerator ItemContainerGenerator { get; }
Property Value
Items
Gets the collection of all RadRadialMenuItem.
Declaration
public ObservableCollection<RadRadialMenuItem> Items { get; }
Property Value
ItemsSource
Gets or sets a collection used to generate the content of the RadRadialMenu.
Declaration
public IEnumerable<IRadialMenuItem> ItemsSource { get; set; }
Property Value
NavigationMenuBackgroundStyle
Gets or sets the Style value that defines the appearance of the navigation buttons panel.
Declaration
public Style NavigationMenuBackgroundStyle { get; set; }
Property Value
Style
Remarks
The Style should target the Rectangle type.
OuterBorderPadding
Gets or sets the distance between the outer ring of the RadRadialMenu and its RadRadialMenuItem.
OuterRadiusFactor
Gets or sets the factor that defines the outer radius of the panel holding the NavigationItemButton items as a fraction of the size of the RadRadialMenu control.
Declaration
public double OuterRadiusFactor { get; set; }
Property Value
The value should be between 0 and 1. If the passed value lies outside this range, it is automatically set to the nearest boundary value.
PopupHorizontalOffset
Gets or sets a PopupHorizontalOffset that determines the horizontal offset of the menu's Popup. This is a dependency property. Only used when PopupPlacement i set to Absolute and AbsolutePoint.
Declaration
public double PopupHorizontalOffset { get; set; }
Property Value
PopupPlacement
Gets or sets a PopupPlacement that determines where the menu would be position. This is a dependency property.
Declaration
public PlacementMode PopupPlacement { get; set; }
Property Value
PlacementMode
PopupVerticalOffset
Gets or sets a PopupVerticalOffset that determines the horizontal offset of the menu's Popup. This is a dependency property. Only used when PopupPlacement i set to Absolute and AbsolutePoint.
ShowEventName
Gets or sets the name of the event that will show the context menu.
Declaration
public string ShowEventName { get; set; }
Property Value
The name of the event.
ShowToolTip
Gets or sets a value that indicates whether a tool tip, displaying the current selected RadRadialMenuItem header text, will be displayed.
StartAngle
Gets or sets the start angle for ordering the RadRadialMenuItem components.
Declaration
public double StartAngle { get; set; }
Property Value
The angle is measured in radians.
StaysOpenOnShow
Gets or sets whether the RadRadialMenu will be automatically opened when shown as context menu.
TargetElement
Gets the target FrameworkElement instance that RadRadialMenu is assigned to.
Declaration
public FrameworkElement TargetElement { get; }
Property Value
FrameworkElement
Remarks
Before the menu is attached to the element this property has null value.
Methods
ApplyTemplateCore()
Called when the Framework is called. Inheritors should override this method should they have some custom template-related logic. This is done to ensure that the property is properly initialized.
CanUpdateVisualState()
Determines whether the current visual state may be updated.
ComposeVisualStateName()
Builds the current visual state for this instance.
GetRadialContextMenu(DependencyObject)
Returns the instance of current RadRadialMenu that is attached to specific FrameworkElement.
Declaration
public static RadRadialMenu GetRadialContextMenu(DependencyObject obj)
Parameters
obj
DependencyObject
The target FrameworkElement.
Returns
The attached RadRadialMenu control.
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call .
Declaration
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Creates a RadRadialMenuAutomationPeer.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
AutomationPeer
OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)
Parameters
e
The RoutedEventArgs that contains the event data.
OnMouseLeave(MouseEventArgs)
Called before the System.Windows.UIElement.MouseLeave event occurs.
Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
e
MouseEventArgs
The data for the event.
OnMouseLeftButtonUp(MouseButtonEventArgs)
Called before the System.Windows.UIElement.MouseLeftButtonUp event occurs.
Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
e
MouseButtonEventArgs
The data for the event.
OnMouseMove(MouseEventArgs)
Called before the System.Windows.UIElement.MouseMove event occurs.
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
e
MouseEventArgs
The data for the event.
OnNavigating(RadialMenuNavigatingEventArgs)
Fires the Navigating event.
Declaration
protected virtual void OnNavigating(RadialMenuNavigatingEventArgs e)
Parameters
e
The data for the event.
OnPreviewToolTipOpen(RadRadialMenuItem, PlacementMode, double, double, double)
Creates the MenuToolTipEventArgs and raises the PreviewToolTipOpen routed event.
Declaration
protected virtual MenuToolTipEventArgs OnPreviewToolTipOpen(RadRadialMenuItem menuItem, PlacementMode placement, double horizontalOffset, double verticalOffset, double outerRadius)
Parameters
menuItem
placement
PlacementMode
horizontalOffset
verticalOffset
outerRadius
Returns
OnPropertyChanged(string)
Called when a value of a property is changed.
Declaration
protected void OnPropertyChanged(string name)
Parameters
name
The name of the property that changes.
OnSelectionChanged(RadRadialMenuItem)
Called when selection is changed.
Declaration
protected virtual void OnSelectionChanged(RadRadialMenuItem item)
Parameters
item
The changed menu item.
OnTemplateApplied()
Occurs when the method has been called and the template is already successfully applied.
Declaration
protected void OnTemplateApplied()
SetRadialContextMenu(DependencyObject, RadRadialMenu)
Attaches an instance of RadRadialMenu to a specific FrameworkElement.
Declaration
public static void SetRadialContextMenu(DependencyObject obj, RadRadialMenu value)
Parameters
obj
DependencyObject
The target FrameworkElement.
value
The RadRadialMenu instance to be attached to the target element.
SetVisualState(string, bool)
Applies the specified visual state as current.
UpdateVisualState(bool)
Re-evaluates the current visual state for the control and updates it if necessary.
Declaration
protected virtual void UpdateVisualState(bool animate)
Parameters
animate
True to use transitions during state update, false otherwise.
Events
Closed
Occurs when a RadRadialMenu is closed.
Declaration
[SRCategory("Behavior")]
public event RadRoutedEventHandler Closed
Event Value
Navigated
Occurs when a RadRadialMenu is navigated to another view.
Declaration
[SRCategory("Behavior")]
public event RadRoutedEventHandler Navigated
Event Value
Navigating
Occurs before a menu level changes.
Declaration
public event EventHandler<RadialMenuNavigatingEventArgs> Navigating
Event Value
Opened
Occurs when a RadRadialMenu is opened.
Declaration
[SRCategory("Behavior")]
public event RadRoutedEventHandler Opened
Event Value
Opening
Occurs before particular instance of RadRadialMenu opens. If it is handled then RadRadialMenu will not open.
Declaration
[SRCategory("Behavior")]
public event RadRoutedEventHandler Opening
Event Value
PreviewToolTipOpen
Occurs before MenuToolTip is shown.
Declaration
public event RadRadialMenu.MenuToolTipEventHandler PreviewToolTipOpen
Event Value
PropertyChanged
Occurs when a property value changes.
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Value
Implements
SelectionChanged
Occurs when menu item is selected/deselected.
Declaration
public event EventHandler<MenuSelectionChangedEventArgs> SelectionChanged
Event Value