Class

RadMenu

Initializes a new instance of the RadMenu class. RadMenu can be horizontal or vertical. You can add, remove, and disable menu items at run-time. It offers full theming support, allowing you to easily construct a variety of stunning visual effects. You can nest any other RadControl within a RadMenu. For example, you can create a menu with an embedded textbox or combobox.

Declaration

public RadMenu()

Gets or sets a value indicating whether all menu items will appear with the same height, using the height of the tallest item in the collection.

Declaration

[Browsable(true)]
public bool AllItemsEqualHeight { get; set; }

Property Value

Gets or sets a value indicating whether this menu allows merging with other RadMenu instances to create a unified menu structure.

Declaration

public bool AllowMerge { get; set; }

Property Value

Gets or sets a value indicating whether the menu automatically adjusts its size to fit its content.

Declaration

public override bool AutoSize { get; set; }

Property Value

Overrides RadControl.AutoSize

Gets or sets the background color of the menu. Note that RadMenu consists of multiple visual elements and separate settings are provided to customize their appearance, so this property might be ignored.

Declaration

public override Color BackColor { get; set; }

Property Value

Overrides RadControl.BackColor

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets which edge of the parent container the menu is docked to.

Declaration

public override DockStyle Dock { get; set; }

Property Value

Overrides Control.Dock

Gets or sets the easing type used for dropdown animations when DropDownAnimationEnabled is true.

Declaration

[Browsable(true)]
public RadEasingType DropDownAnimationEasing { get; set; }

Property Value

Gets or sets a value indicating whether dropdown animations are enabled when submenu items are displayed.

Declaration

[Browsable(true)]
public bool DropDownAnimationEnabled { get; set; }

Property Value

Gets or sets the number of frames used for dropdown animations when DropDownAnimationEnabled is true.

Declaration

[Browsable(true)]
public int DropDownAnimationFrames { get; set; }

Property Value

Gets or sets a value indicating whether this RadMenu handles MDI (Multiple Document Interface) menu functionality and system buttons for child forms.

Declaration

[Browsable(true)]
public bool IsMainMenu { get; set; }

Property Value

Gets the collection of root menu items that are displayed in the menu. Root items are top-level menu items that have no parent item and can contain child items as submenus.

Declaration

[RadEditItemsAction]
[RadNewItem("Type here", true, true, false)]
[Browsable(true)]
public override RadItemOwnerCollection Items { get; }

Property Value

Overrides RadItemsControl.Items

Gets the instance of RadMenuElement wrapped by this control. RadMenuElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadMenu.

Declaration

[Browsable(false)]
public RadMenuElement MenuElement { get; }

Property Value

Gets or sets the Orientation of menu items, determining whether they are arranged horizontally or vertically.

Declaration

[Browsable(true)]
public Orientation Orientation { get; set; }

Property Value

Gets or sets a value indicating whether menu items should be stretched to fill the available space in the menu.

Declaration

[Browsable(true)]
public bool StretchItems { get; set; }

Property Value

Gets or sets a value indicating whether the Alt or F10 keys can be used to highlight and activate the menu for keyboard navigation.

Declaration

[Browsable(true)]
public bool SystemKeyHighlight { get; set; }

Property Value

Declaration

protected override bool CallBaseProcessDialogKey(Keys keyData)

Parameters

Returns

Overrides RadItemsControl.CallBaseProcessDialogKey(Keys)

Declaration

protected virtual bool CanProcessItem(RadMenuItemBase menuItem)

Parameters

Returns

Determines whether the specified character can be processed as a mnemonic for any menu item.

Declaration

public override bool CanProcessMnemonic(char keyData)

Parameters

Returns

Overrides RadItemsControl.CanProcessMnemonic(char)

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

Creates and initializes the child elements of the menu, including the RadMenuElement and its event handlers.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Declaration

protected override RootRadElement CreateRootElement()

Returns

Overrides RadControl.CreateRootElement()

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides RadControl.Dispose(bool)

Declaration

protected virtual RadMenuItemBase GetCurrentProcessedItem(IItemsControl itemsControl)

Parameters

Returns

Declaration

protected virtual RadMenuItemBase GetSysCharItem(IItemsControl itemsControl, char searchKey)

Parameters

Returns

Initializes the root element with default property values for the menu.

Declaration

protected override void InitializeRootElement(RootRadElement rootElement)

Parameters

Overrides RadControl.InitializeRootElement(RootRadElement)

Merges the specified RadMenu with this menu, combining their menu items according to merge settings.

Declaration

public virtual void MergeMenu(RadMenu sourceMenu)

Parameters

Exceptions

Raises the AllItemsEqualHeightChanged event when the equal height setting for menu items changes.

Declaration

protected virtual void OnAllItemsEqualHeightChanged(EventArgs args)

Parameters

Called when the control handle is created. Sets up MDI functionality and system button handling if the parent form is an MDI container.

Declaration

protected override void OnHandleCreated(EventArgs e)

Parameters

Overrides Control.OnHandleCreated(EventArgs)

Declaration

protected override void OnHandleDestroyed(EventArgs e)

Parameters

Overrides RadControl.OnHandleDestroyed(EventArgs)

Declaration

protected override void OnItemDeselected(ItemSelectedEventArgs args)

Parameters

Overrides RadItemsControl.OnItemDeselected(ItemSelectedEventArgs)

Declaration

protected override void OnItemSelected(ItemSelectedEventArgs args)

Parameters

Overrides RadItemsControl.OnItemSelected(ItemSelectedEventArgs)

Declaration

protected override void OnLeave(EventArgs e)

Parameters

Overrides Control.OnLeave(EventArgs)

Notifies that the control is about to be visualized.

Declaration

protected override void OnLoad(Size desiredSize)

Parameters

Overrides RadControl.OnLoad(Size)

Called when the menu state changes, handling the transition between different RadMenu.RadMenuState values.

Declaration

protected virtual void OnMenuStateChanged(RadMenu.RadMenuState oldState, RadMenu.RadMenuState newState)

Parameters

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseDown(MouseEventArgs)

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseMove(MouseEventArgs)

Raises the OrientationChanged event when the menu orientation changes.

Declaration

protected virtual void OnOrientationChanged(EventArgs args)

Parameters

Raises the TextOrientationChanged event when the text orientation property value changes.

Declaration

protected virtual void OnTextOrientationChanged(EventArgs args)

Parameters

Declaration

protected virtual void PerformMouseDown(RadMenuItemBase menuItem)

Parameters

Declaration

protected virtual void PreprocessMouseEvent(ref Message msg)

Parameters

Declaration

protected override bool ProcessArrowKey(Keys keyCode)

Parameters

Returns

Overrides RadItemsControl.ProcessArrowKey(Keys)

Declaration

protected override void ProcessAutoSizeChanged(bool value)

Parameters

Overrides RadControl.ProcessAutoSizeChanged(bool)

Declaration

protected override bool ProcessCmdKey(ref Message m, Keys keyData)

Parameters

Returns

Overrides RadItemsControl.ProcessCmdKey(ref Message, Keys)

Declaration

protected override void ProcessCodedUIMessage(ref IPCMessage request)

Parameters

Overrides RadControl.ProcessCodedUIMessage(ref IPCMessage)

Declaration

protected override bool ProcessDialogKey(Keys keyData)

Parameters

Returns

Overrides RadItemsControl.ProcessDialogKey(Keys)

Declaration

protected virtual bool ProcessFirstStageMnemonicActivation(ref Message m, Keys keyData)

Parameters

Returns

Processes a focus request from the specified element.

Declaration

protected override bool ProcessFocusRequested(RadElement element)

Parameters

Returns

Overrides RadControl.ProcessFocusRequested(RadElement)

Declaration

protected override bool ProcessLeftRightArrowKey(bool right)

Parameters

Returns

Overrides RadItemsControl.ProcessLeftRightArrowKey(bool)

Declaration

protected override bool ProcessMnemonic(char charCode)

Parameters

Returns

Overrides RadControl.ProcessMnemonic(char)

Declaration

protected virtual bool ProcessSecondStageMnemonicActivation(ref Message m, Keys keyData)

Parameters

Returns

Declaration

protected override bool ProcessUpDownArrowKey(bool down)

Parameters

Returns

Overrides RadItemsControl.ProcessUpDownArrowKey(bool)

Declaration

protected override void ResetBackColorThemeOverrides()

Overrides RadControl.ResetBackColorThemeOverrides()

Declaration

protected override void SetBackColorThemeOverrides()

Overrides RadControl.SetBackColorThemeOverrides()

Sets the current state of the menu for mnemonic and keyboard processing.

Declaration

public void SetMenuState(RadMenu.RadMenuState state)

Parameters

Removes the merge relationship with the specified RadMenu, restoring the original menu structure.

Declaration

public void UnmergeMenu(RadMenu src)

Parameters

Occurs when the AllItemsEqualHeight property value changes, indicating a change in the height uniformity setting for menu items.

Declaration

public event EventHandler AllItemsEqualHeightChanged

Event Value

Occurs when the Orientation property value changes, indicating a change in the layout direction of menu items.

Declaration

public event EventHandler OrientationChanged

Event Value

Occurs when the text orientation property value changes, affecting how text is displayed within menu items.

Declaration

public event EventHandler TextOrientationChanged

Event Value