Inheritance
System.Object
MenuBuilder
Assembly: Syncfusion.EJ2.dll
public class MenuBuilder : ControlBuilder
Constructors
Declaration
Declaration
public MenuBuilder(Menu model)
Parameters
Type |
Name |
Description |
Menu |
model |
|
Fields
Declaration
Field Value
Properties
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type |
System.Collections.Generic.IDictionary<System.String, System.Object> |
Declaration
public string ID { get; set; }
Property Value
Declaration
public override TextWriter Output { get; set; }
Property Value
Type |
System.IO.TextWriter |
Overrides
Methods
Specifies the animation settings for the sub menu open.
Declaration
public MenuBuilder AnimationSettings(MenuAnimationSettings animationSettings)
Parameters
Returns
Declaration
public MenuBuilder AnimationSettings(Action<MenuAnimationSettingsBuilder> animationSettings)
Parameters
Returns
Triggers before closing the menu.
Declaration
public MenuBuilder BeforeClose(string beforeClose)
Parameters
Type |
Name |
Description |
System.String |
beforeClose |
|
Returns
Triggers while rendering each menu item.
Declaration
public MenuBuilder BeforeItemRender(string beforeItemRender)
Parameters
Type |
Name |
Description |
System.String |
beforeItemRender |
|
Returns
Triggers before opening the menu item.
Declaration
public MenuBuilder BeforeOpen(string beforeOpen)
Parameters
Type |
Name |
Description |
System.String |
beforeOpen |
|
Returns
Triggers once the component rendering is completed.
Declaration
public MenuBuilder Created(string created)
Parameters
Type |
Name |
Description |
System.String |
created |
|
Returns
Defines class/multiple classes separated by a space in the Menu wrapper.
Declaration
public MenuBuilder CssClass(string cssClass)
Parameters
Type |
Name |
Description |
System.String |
cssClass |
|
Returns
Specifies whether to enable the rendering of untrusted HTML values in the Menu component.
If 'enableHtmlSanitizer' set to true, the component will sanitize any suspected untrusted strings and scripts before rendering them.
Declaration
public MenuBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableHtmlSanitizer |
|
Returns
Enable or disable persisting component's state between page reloads.
Declaration
public MenuBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enablePersistence |
|
Returns
Enable or disable rendering component in right to left direction.
Declaration
public MenuBuilder EnableRtl(bool enableRtl = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableRtl |
|
Returns
Specifies whether to enable / disable the scrollable option in Menu.
Declaration
public MenuBuilder EnableScrolling(bool enableScrolling = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableScrolling |
|
Returns
Specifies mapping fields from the dataSource.
Declaration
public MenuBuilder Fields(MenuFieldSettings fields)
Parameters
Returns
Declaration
public MenuBuilder Fields(Action<MenuFieldSettingsBuilder> fields)
Parameters
Returns
Specifies whether to enable / disable the hamburger mode in Menu.
Declaration
public MenuBuilder HamburgerMode(bool hamburgerMode = true)
Parameters
Type |
Name |
Description |
System.Boolean |
hamburgerMode |
|
Returns
If hoverDelay is set by particular number, the menu will open after that period.
Declaration
public MenuBuilder HoverDelay(double hoverDelay)
Parameters
Type |
Name |
Description |
System.Double |
hoverDelay |
|
Returns
Allows additional HTML attributes such as title, name, etc., and
accepts n number of attributes in a key-value pair format.
Declaration
public MenuBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type |
Name |
Description |
System.Object |
htmlAttributes |
|
Returns
Declaration
public MenuBuilder Items(Action<MenuItemBuilder> items)
Parameters
Returns
Specifies menu items with its properties which will be rendered as Menu.
Declaration
public MenuBuilder Items(List<MenuItem> items)
Parameters
Type |
Name |
Description |
System.Collections.Generic.List<MenuItem> |
items |
|
Returns
Specifies menu items with its properties which will be rendered as Menu.
Declaration
public MenuBuilder Items(object items)
Parameters
Type |
Name |
Description |
System.Object |
items |
|
Returns
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public MenuBuilder Locale(string locale)
Parameters
Type |
Name |
Description |
System.String |
locale |
|
Returns
Triggers while closing the menu.
Declaration
public MenuBuilder OnClose(string onClose)
Parameters
Type |
Name |
Description |
System.String |
onClose |
|
Returns
Triggers while opening the menu item.
Declaration
public MenuBuilder OnOpen(string onOpen)
Parameters
Type |
Name |
Description |
System.String |
onOpen |
|
Returns
Specified the orientation of Menu whether it can be horizontal or vertical.
Declaration
public MenuBuilder Orientation(Orientation orientation)
Parameters
Returns
Declaration
public HtmlString Render()
Returns
Type |
Microsoft.AspNetCore.Html.HtmlString |
Triggers while selecting menu item.
Declaration
public MenuBuilder Select(string select)
Parameters
Type |
Name |
Description |
System.String |
select |
|
Returns
Specifies whether to show the sub menu or not on click.
When set to true, the sub menu will open only on mouse click.
Declaration
public MenuBuilder ShowItemOnClick(bool showItemOnClick = true)
Parameters
Type |
Name |
Description |
System.Boolean |
showItemOnClick |
|
Returns
Specifies target element to open/close Menu while click in Hamburger mode.
Declaration
public MenuBuilder Target(string target)
Parameters
Type |
Name |
Description |
System.String |
target |
|
Returns
Specifies the template for Menu item.
Declaration
public MenuBuilder Template(string template)
Parameters
Type |
Name |
Description |
System.String |
template |
|
Returns
Specifies the title text for hamburger mode in Menu.
Declaration
public MenuBuilder Title(string title)
Parameters
Type |
Name |
Description |
System.String |
title |
|
Returns