ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class MenuBuilder - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class MenuBuilder

    Inheritance
    System.Object
    ControlBuilder
    MenuBuilder
    Inherited Members
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.Navigations
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class MenuBuilder : ControlBuilder

    Constructors

    MenuBuilder()

    Declaration
    public MenuBuilder()

    MenuBuilder(Menu)

    Declaration
    public MenuBuilder(Menu model)
    Parameters
    Type Name Description
    Menu model

    Fields

    model

    Declaration
    public Menu model
    Field Value
    Type Description
    Menu

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

    Declaration
    public string ID { get; set; }
    Property Value
    Type Description
    System.String

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    AnimationSettings(MenuAnimationSettings)

    Specifies the animation settings for the sub menu open.

    Declaration
    public MenuBuilder AnimationSettings(MenuAnimationSettings animationSettings)
    Parameters
    Type Name Description
    MenuAnimationSettings animationSettings
    Returns
    Type Description
    MenuBuilder

    AnimationSettings(Action<MenuAnimationSettingsBuilder>)

    Declaration
    public MenuBuilder AnimationSettings(Action<MenuAnimationSettingsBuilder> animationSettings)
    Parameters
    Type Name Description
    System.Action<MenuAnimationSettingsBuilder> animationSettings
    Returns
    Type Description
    MenuBuilder

    BeforeClose(String)

    Triggers before closing the menu.

    Declaration
    public MenuBuilder BeforeClose(string beforeClose)
    Parameters
    Type Name Description
    System.String beforeClose
    Returns
    Type Description
    MenuBuilder

    BeforeItemRender(String)

    Triggers while rendering each menu item.

    Declaration
    public MenuBuilder BeforeItemRender(string beforeItemRender)
    Parameters
    Type Name Description
    System.String beforeItemRender
    Returns
    Type Description
    MenuBuilder

    BeforeOpen(String)

    Triggers before opening the menu item.

    Declaration
    public MenuBuilder BeforeOpen(string beforeOpen)
    Parameters
    Type Name Description
    System.String beforeOpen
    Returns
    Type Description
    MenuBuilder

    Created(String)

    Triggers once the component rendering is completed.

    Declaration
    public MenuBuilder Created(string created)
    Parameters
    Type Name Description
    System.String created
    Returns
    Type Description
    MenuBuilder

    CssClass(String)

    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
    Type Description
    MenuBuilder

    EnableHtmlSanitizer(Boolean)

    Defines whether to allow the cross-scripting site or not.

    Declaration
    public MenuBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
    Parameters
    Type Name Description
    System.Boolean enableHtmlSanitizer
    Returns
    Type Description
    MenuBuilder

    EnablePersistence(Boolean)

    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
    Type Description
    MenuBuilder

    EnableRtl(Boolean)

    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
    Type Description
    MenuBuilder

    EnableScrolling(Boolean)

    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
    Type Description
    MenuBuilder

    Fields(MenuFieldSettings)

    Specifies mapping fields from the dataSource.

    Declaration
    public MenuBuilder Fields(MenuFieldSettings fields)
    Parameters
    Type Name Description
    MenuFieldSettings fields
    Returns
    Type Description
    MenuBuilder

    Fields(Action<MenuFieldSettingsBuilder>)

    Declaration
    public MenuBuilder Fields(Action<MenuFieldSettingsBuilder> fields)
    Parameters
    Type Name Description
    System.Action<MenuFieldSettingsBuilder> fields
    Returns
    Type Description
    MenuBuilder

    HamburgerMode(Boolean)

    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
    Type Description
    MenuBuilder

    HtmlAttributes(Object)

    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
    Type Description
    MenuBuilder

    Items(Action<MenuItemBuilder>)

    Declaration
    public MenuBuilder Items(Action<MenuItemBuilder> items)
    Parameters
    Type Name Description
    System.Action<MenuItemBuilder> items
    Returns
    Type Description
    MenuBuilder

    Items(List<MenuItem>)

    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
    Type Description
    MenuBuilder

    Items(Object)

    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
    Type Description
    MenuBuilder

    Locale(String)

    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
    Type Description
    MenuBuilder

    OnClose(String)

    Triggers while closing the menu.

    Declaration
    public MenuBuilder OnClose(string onClose)
    Parameters
    Type Name Description
    System.String onClose
    Returns
    Type Description
    MenuBuilder

    OnOpen(String)

    Triggers while opening the menu item.

    Declaration
    public MenuBuilder OnOpen(string onOpen)
    Parameters
    Type Name Description
    System.String onOpen
    Returns
    Type Description
    MenuBuilder

    Orientation(Orientation)

    Specified the orientation of Menu whether it can be horizontal or vertical.

    Declaration
    public MenuBuilder Orientation(Orientation orientation)
    Parameters
    Type Name Description
    Orientation orientation
    Returns
    Type Description
    MenuBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    Microsoft.AspNetCore.Html.HtmlString

    Select(String)

    Triggers while selecting menu item.

    Declaration
    public MenuBuilder Select(string select)
    Parameters
    Type Name Description
    System.String select
    Returns
    Type Description
    MenuBuilder

    ShowItemOnClick(Boolean)

    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
    Type Description
    MenuBuilder

    Target(String)

    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
    Type Description
    MenuBuilder

    Template(String)

    Specifies the template for Menu item.

    Declaration
    public MenuBuilder Template(string template)
    Parameters
    Type Name Description
    System.String template
    Returns
    Type Description
    MenuBuilder

    Title(String)

    Specifies the title text for hamburger mode in Menu.

    Declaration
    public MenuBuilder Title(string title)
    Parameters
    Type Name Description
    System.String title
    Returns
    Type Description
    MenuBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved