| Name | Type | Default | Description |
|---|
| AutoCloseDelay | int | 100 | Determines delay (in milliseconds) before a Menu dropdown is closed when leaving the Menu with the mouse. Applicable only when selectionMode is 'mouseenter'. |
| AutoFocusOnMouseenter | bool | false | If set to true, on mouseenter, the element receives focus automatically. |
| Checkable | bool | false | Allows top-level Menu items (immediate children of the Menu) to be checkable. Sublevels are controlled by setting checkable to the respective Smart-menu-items-group. |
| Checkboxes | bool | false | Sets or gets whether checkboxes and radio buttons can be displayed in the Menu. This property is applicable only to the Menu itself, and not its Smart-menu-item/Smart-menu-items-group subitems. See also the property checkable. |
| CheckMode | MenuCheckMode | MenuCheckMode.Checkbox | Sets the check mode of top-level Menu items (immediate children of the Menu). checkMode can be set to 'checkbox', 'radioButton', or a comma-separated list containing 'checkbox', 'radioButton', or 'none' (e.g. 'checkbox, radioButton, none, checkbox'). When set to a list, each value in the list is applied to groups of Menu items separated by an item with separator (item after the one with separator is the start of a new checkMode context). Sublevels are controlled by setting checkMode to the respective Smart-menu-items-group. |
| CloseAction | MenuCloseAction | MenuCloseAction.Up | Sets the document event which closes any open Menu drop downs (or the Menu itself when mode is 'dropDown'). |
| DataSource | IEnumerable<object> | N/A | Determines the data source that will be loaded to the Menu. The data source represents an array of objects with the following properties: - label - a string representing the text content of the item.
- value - the value of the item.
- shortcut - a string representing a shortuct for the item. It will be displayed inside the item.
- items - allows to define an array of sub menu items.
|
| Disabled | bool | false | Enables or disables element. |
| DisplayMember | string | "label" | Determines the field in the data source that corresponds to an item's label. |
| DropDownAppendTo | string | N/A | Sets custom outer container, where all dropdown containers must be appended. By default they are inside the menu. The value of the property can be an HTML element or the id of an HTML element. In mode 'dropDown', the property dropDownAppendTo also controls the parent element of the whole Menu. The open method works relatively to the original place of the Menu in the DOM. |
| DropDownOverlay | bool | false | If this property is enabled, when an element's dropdown is opened, a transparent overlay is positioned between the dropdown and the rest of the document. |
| DropDownPosition | MenuDropDownPosition | MenuDropDownPosition.Auto | Determines the opening direction of Menu dropdowns. |
| Items | IEnumerable<object> | | A getter that returns an array of all Menu items. |
| ItemsMember | string | "items" | Determines the field in the data source that corresponds to an item group's subitems collection. |
| Locale | string | "en" | Sets or gets the language. Used in conjunction with the property messages. |
| Messages | object | N/A | Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. |
| MinimizeIconTemplate | string | "null" | Used to load a custom minimize icon from an HTMLTemplateElement object. The HTMLTemplateElement is selected by it's id. |
| MinimizeWidth | int | N/A | Determines the minimum width of the Menu at which it will switch from normal to minimized mode. If set to null, the Menu does not minimize automatically. |
| Mode | MenuMode | MenuMode.Horizontal | Determines the menu's display mode. |
| IsOpened | bool | false | Opens or closes thte menu when it's in 'dropDown' mode. |
| Overflow | Overflow | Overflow.Auto | Sets or gets the menu's scroll buttons behavior. Applicable only when dropDownAppendTo is not null. |
| PreventCloseOnCheck | bool | false | If set to true, prevents the closing of the Menu or its dropdowns when Menu items are checked/unchecked. |
| Readonly | bool | false | If the element is readonly, users cannot interact with it. |
| RightToLeft | bool | false | Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. |
| SelectionMode | MenuSelectionMode | MenuSelectionMode.Click | Determines the menu's selection mode. |
| Theme | string | "" | Determines the theme. Theme defines the look of the element |
| Unfocusable | bool | false | If is set to true, the element cannot be focused. |
| ValueMember | string | "value" | Determines the field in the data source that corresponds to an item's value. |
| Name | Type | Arguments | Description |
|---|
| AddItem | void | object Item, object Parent | Adds an item to the menu.Args: object Item - A smart-menu-item to add to the Menu.,object Parent - The smart-menu-items-group or its id or numeric path to add the item to. |
| AddItem | void | object Item | Adds an item to the menu. |
| CheckItem | void | object item | Checks an item.Args: object item - smart-menu-item/smart-menu-items-group or its id or numeric path. |
| Clear | void | N/A | Clears all Menu items. |
| ClickItem | void | object item | Clicks on an item programatically.Args: object item - smart-menu-item/smart-menu-items-group or its id or numeric path. |
| Close | void | N/A | Closes the Menu when "mode" is "'dropDown'". |
| CollapseItem | void | object item, bool animation | Collapses an item.Args: object item - smart-menu-item/smart-menu-items-group or its id or numeric path. If no item is passed, all open items are collapsed.,bool animation - If set to false, disables collapse animation even if animation is enabled for the element. |
| CollapseItem | void | N/A | Collapses an item. |
| ExpandItem | void | object item, bool animation | Expands an item.Args: object item - smart-menu-item/smart-menu-items-group or its id or numeric path.,bool animation - If set to false, disables expand animation even if animation is enabled for the element. |
| ExpandItem | void | object item | Expands an item. |
| GetDataSourceAsync() | Task<IEnumerable<object>> | 'N/A' | Gets the "DataSource" property as Task<IEnumerable<object>>. |
| GetIsOpenedAsync() | Task<bool> | 'N/A' | Gets the "IsOpened" property as Task<bool>. |
| GetItem | object | string id | Gets an item by its id or numeric path.Args: string id - The id or numeric path of an item |
| Maximize | void | N/A | Maximizes the Menu. |
| Minimize | void | N/A | Minimizes the Menu. |
| Open | void | int left, int top | Opens the Menu when "mode" is "'dropDown'".Args: int left - Horizontal position,int top - Vertical position |
| Refresh | void | 'N/A' | Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements. |
| RemoveItem | void | object item | Removes an item from the menu.Args: object item - The smart-menu-item/smart-menu-items-group or its id or numeric path to remove. |
| Render | void | 'N/A' | Re-renders the Blazor Component. This method will make a full re-render. |
| StateHasChanged | void | 'N/A' | Refreshes the state and Re-renders the Blazor Component, if necessary. |
| UncheckItem | void | object item | Unchecks an item.Args: object item - smart-menu-item/smart-menu-items-group (or its id or numeric path) |
| Name | Type | Description | Event Detail |
|---|
| OnClose | EventCallback<Event> | This event is triggered when the menu is closed. The event is fired only in "'dropDown'" "mode". | N/A |
| Closed | event MenuClosedEventHandler | This event is triggered when the menu is closed. The event is fired only in "'dropDown'" "mode". | MenuClosedEventArgs |
| OnClosing | EventCallback<Event> | This event is triggered when the menu is about to be closed. The closing operation can be canceled by calling event.preventDefault() in the event handler function. The event is fired only in "'dropDown'" "mode". | dynamic trigger- Indicates whether the event was called from inside the element or programatically. |
| Closing | event MenuClosingEventHandler | This event is triggered when the menu is about to be closed. The closing operation can be canceled by calling event.preventDefault() in the event handler function. The event is fired only in "'dropDown'" "mode". | MenuClosingEventArgs |
| OnCollapse | EventCallback<Event> | This event is triggered when a jqx-menu-items-group is collapsed. | dynamic item- The menu item that was collapsed., string label- The label of the toggled item that was collapsed., dynamic value- The value of the toggled item that was collapsed., dynamic path- The path of the toggled item that was collapsed, e.g. '0.1', '1.1.2'., dynamic children- The children items of the toggled item that was collapsed. |
| Collapsed | event MenuCollapsedEventHandler | This event is triggered when a jqx-menu-items-group is collapsed. | MenuCollapsedEventArgs |
| OnCollapsing | EventCallback<Event> | This event is triggered when a jqx-menu-items-group is collapsing. | dynamic item- The menu item that is going to be collapsed., string label- The label of the toggled item that is going to be collapsed., dynamic value- The value of the toggled item that is going to be collapsed., dynamic path- The path of the toggled item that is going to be collapsed, e.g. '0.1', '1.1.2'., dynamic children- The children items of the toggled item that is going to be collapsed. |
| Collapsing | event MenuCollapsingEventHandler | This event is triggered when a jqx-menu-items-group is collapsing. | MenuCollapsingEventArgs |
| OnExpand | EventCallback<Event> | This event is triggered when a jqx-menu-items-group is expanded. | dynamic item- The menu item that was expanded., string label- The label of the toggled item that was expanded., dynamic value- The value of the toggled item that was expanded., dynamic path- The path of the toggled item that was expanded, e.g. '0.1', '1.1.2'., dynamic children- The children items of the toggled item that was expanded. |
| Expanded | event MenuExpandedEventHandler | This event is triggered when a jqx-menu-items-group is expanded. | MenuExpandedEventArgs |
| OnExpanding | EventCallback<Event> | This event is triggered before a jqx-menu-items-group is expanded. | dynamic item- The menu item that is going to be expanded., string label- The label of the toggled item that is going to be expanded., dynamic value- The value of the toggled item that is going to be expanded., dynamic path- The path of the toggled item that is going to be expanded, e.g. '0.1', '1.1.2'., dynamic children- The children items of the toggled item that is going to be expanded. |
| Expanding | event MenuExpandingEventHandler | This event is triggered before a jqx-menu-items-group is expanded. | MenuExpandingEventArgs |
| OnItemCheckChange | EventCallback<Event> | This event is triggered when a menu item check state is changed. | dynamic item- The menu item which state was changed., string label- The label of the item which state was changed., dynamic value- The value of the item which state was changed., dynamic checked- The checked state of the toggled item. If false the item is not toggled. |
| ItemCheckChanged | event MenuItemCheckChangedEventHandler | This event is triggered when a menu item check state is changed. | MenuItemCheckChangedEventArgs |
| OnItemClick | EventCallback<Event> | This event is triggered when a menu item is clicked. | dynamic item- The menu item that is toggled., string label- The label of the toggled item., dynamic value- The value of the toggled item. |
| ItemClicked | event MenuItemClickedEventHandler | This event is triggered when a menu item is clicked. | MenuItemClickedEventArgs |
| OnOpen | EventCallback<Event> | This event is triggered when the menu is opened. The event is fired only in "'dropDown'" "mode". | N/A |
| Opened | event MenuOpenedEventHandler | This event is triggered when the menu is opened. The event is fired only in "'dropDown'" "mode". | MenuOpenedEventArgs |
| OnOpening | EventCallback<Event> | This event is triggered when the menu is about to be opened. The opening operation can be canceled by calling event.preventDefault() in the event handler function. The event is fired only in "'dropDown'" "mode". | N/A |
| Opening | event MenuOpeningEventHandler | This event is triggered when the menu is about to be opened. The opening operation can be canceled by calling event.preventDefault() in the event handler function. The event is fired only in "'dropDown'" "mode". | MenuOpeningEventArgs |