Class ContextMenuBuilder

Inheritance

System.Object

ControlBuilder

ContextMenuBuilder

Inherited Members

ControlBuilder.Context

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.EJ2.Navigations

Assembly: Syncfusion.EJ2.dll

Syntax

public class ContextMenuBuilder : ControlBuilder

Constructors

ContextMenuBuilder()

Declaration

public ContextMenuBuilder()

ContextMenuBuilder(ContextMenu)

Declaration

public ContextMenuBuilder(ContextMenu model)

Parameters

Type	Name	Description
ContextMenu	model

Fields

model

Declaration

public ContextMenu model

Field Value

Type	Description
ContextMenu

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(ContextMenuAnimationSettings)

Specifies the animation settings for the sub menu open.

Declaration

public ContextMenuBuilder AnimationSettings(ContextMenuAnimationSettings animationSettings)

Parameters

Type	Name	Description
ContextMenuAnimationSettings	animationSettings

Returns

Type	Description
ContextMenuBuilder

AnimationSettings(Action<ContextMenuAnimationSettingsBuilder>)

Declaration

public ContextMenuBuilder AnimationSettings(Action<ContextMenuAnimationSettingsBuilder> animationSettings)

Parameters

Type	Name	Description
System.Action<ContextMenuAnimationSettingsBuilder>	animationSettings

Returns

Type	Description
ContextMenuBuilder

BeforeClose(String)

Triggers before closing the menu.

Declaration

public ContextMenuBuilder BeforeClose(string beforeClose)

Parameters

Type	Name	Description
System.String	beforeClose

Returns

Type	Description
ContextMenuBuilder

BeforeItemRender(String)

Triggers while rendering each menu item.

Declaration

public ContextMenuBuilder BeforeItemRender(string beforeItemRender)

Parameters

Type	Name	Description
System.String	beforeItemRender

Returns

Type	Description
ContextMenuBuilder

BeforeOpen(String)

Triggers before opening the menu item.

Declaration

public ContextMenuBuilder BeforeOpen(string beforeOpen)

Parameters

Type	Name	Description
System.String	beforeOpen

Returns

Type	Description
ContextMenuBuilder

Created(String)

Triggers once the component rendering is completed.

Declaration

public ContextMenuBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
ContextMenuBuilder

CssClass(String)

Defines class/multiple classes separated by a space in the Menu wrapper.

Declaration

public ContextMenuBuilder CssClass(string cssClass)

Parameters

Type	Name	Description
System.String	cssClass

Returns

Type	Description
ContextMenuBuilder

EnableHtmlSanitizer(Boolean)

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

Declaration

public ContextMenuBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)

Parameters

Type	Name	Description
System.Boolean	enableHtmlSanitizer

Returns

Type	Description
ContextMenuBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration

public ContextMenuBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
ContextMenuBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public ContextMenuBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
ContextMenuBuilder

Filter(String)

Specifies the filter selector for elements inside the target in that the context menu will be opened.

Declaration

public ContextMenuBuilder Filter(string filter)

Parameters

Type	Name	Description
System.String	filter

Returns

Type	Description
ContextMenuBuilder

HoverDelay(Double)

If hoverDelay is set by particular number, the menu will open after that period.

Declaration

public ContextMenuBuilder HoverDelay(double hoverDelay)

Parameters

Type	Name	Description
System.Double	hoverDelay

Returns

Type	Description
ContextMenuBuilder

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 ContextMenuBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
ContextMenuBuilder

Items(Action<ContextMenuItemBuilder>)

Declaration

public ContextMenuBuilder Items(Action<ContextMenuItemBuilder> items)

Parameters

Type	Name	Description
System.Action<ContextMenuItemBuilder>	items

Returns

Type	Description
ContextMenuBuilder

Items(Object)

Specifies menu items with its properties which will be rendered as ContextMenu.

Declaration

public ContextMenuBuilder Items(object items)

Parameters

Type	Name	Description
System.Object	items

Returns

Type	Description
ContextMenuBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public ContextMenuBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
ContextMenuBuilder

OnClose(String)

Triggers while closing the menu.

Declaration

public ContextMenuBuilder OnClose(string onClose)

Parameters

Type	Name	Description
System.String	onClose

Returns

Type	Description
ContextMenuBuilder

OnOpen(String)

Triggers while opening the menu item.

Declaration

public ContextMenuBuilder OnOpen(string onOpen)

Parameters

Type	Name	Description
System.String	onOpen

Returns

Type	Description
ContextMenuBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
System.Web.HtmlString

Select(String)

Triggers while selecting menu item.

Declaration

public ContextMenuBuilder Select(string select)

Parameters

Type	Name	Description
System.String	select

Returns

Type	Description
ContextMenuBuilder

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 ContextMenuBuilder ShowItemOnClick(bool showItemOnClick = true)

Parameters

Type	Name	Description
System.Boolean	showItemOnClick

Returns

Type	Description
ContextMenuBuilder

Target(String)

Specifies target element selector in which the ContextMenu should be opened.

Declaration

public ContextMenuBuilder Target(string target)

Parameters

Type	Name	Description
System.String	target

Returns

Type	Description
ContextMenuBuilder