ContextMenuContainer Class

Context menu container class (calls the assigned context menu).

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.ExtendedControls.CMSWebControl
        CMS.ExtendedControls.ContextMenuContainer
          CMS.ExtendedControls.ContextMenuButton
          CMS.ExtendedControls.GroupMenuContainer
          CMS.ExtendedControls.UserMenuContainer

Namespace: CMS.ExtendedControls
Assembly: CMS.ExtendedControls (in CMS.ExtendedControls.dll) Version: 8.2.23

Syntax

public class ContextMenuContainer : CMSWebControl

The ContextMenuContainer type exposes the following members.

Constructors

	Name	Description
Public method	ContextMenuContainer

Methods

	Name	Description
Protected method	EnsureMenuControl	Ensures the menu control.
Public method Static member	GetEndTag()	Gets the div end tag for context menu container.
Public method Static member	GetEndTag(Boolean)	Gets the end tag for context menu container.
Public method Static member	GetEndTag(HtmlTextWriterTag)	Gets the end tag for context menu container.
Public method Static member	GetStartDisabledTag	Gets the start tag for context menu container in disabled state
Public method Static member	GetStartTag(String, String)	Gets the start tag for context menu container.
Public method Static member	GetStartTag(String, String, Boolean, Boolean)	Gets the start tag for context menu container.
Public method Static member	GetStartTag(String, String, Boolean, HtmlTextWriterTag, String, String)	Gets the start tag for context menu container.
Public method Static member	GetStartTag(String, String, Boolean, HtmlTextWriterTag, String, String, String, Boolean, String)	Gets the start tag for context menu container.
Public method	InitializeMenuControl	Initializes menu control properties
Protected method	OnInit	Control Init event. (Overrides CMSWebControl.OnInit(EventArgs).)
Protected method	OnLoad	Control Load event. (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	Control PreRender event. (Overrides Control.OnPreRender(EventArgs).)
Protected method	ReloadMenuData	Reload menu data.
Protected method	Render	Control Render event. (Overrides WebControl.Render(HtmlTextWriter).)
Public method	RenderBeginTag	Renders the begin tag of the control (Overrides WebControl.RenderBeginTag(HtmlTextWriter).)
Public method	RenderEndTag	Renders the end tag of the control (Overrides WebControl.RenderEndTag(HtmlTextWriter).)
Public method	RenderStartTag	Renders the start tag for the menu container.

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mContextMenuCssClass	Context menu CSS class.
Protected field	mCssStyle	CSS style.
Protected field	mHorizontalPosition	Horizontal position.
Protected field	mCheckRelative	If true, relative ancestor div is checked
Protected field	mMenuControl	Menu control.
Protected field	mMenuID	Menu ID.
Protected field	mMouseButton	Mouse button.
Protected field	mParameter	Menu parameter.
Protected field	mRenderAsTag	Default render tag.
Protected field	mResourcePrefix	Prefix for the resource strings which will be used for the strings of the context menu.
Protected field	mStopProcessing	Indicates if the control should perform the operations.
Protected field	mVerticalPosition	Vertical position.

Properties

	Name	Description
Public property	ActiveItemCssClass	CSS class of highlighted element when context menu is opened.
Public property	ActiveItemInactiveCssClass	CSS class of highlighted element when context menu is closed.
Public property	ContextMenuCssClass	Context menu CSS class.
Public property	ContextMenuParent	Control which is the parent for the context menu.
Public property	CssStyle	Container CSS style.
Public property	EnableMouseClick	Enable mouse click.
Public property	GetContextMethod	Name of the javascript method which provides the element context to the menu
Public property	HorizontalPosition	Horizontal position.
Public property	CheckRelative	If true, relative ancestor div is checked
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	MenuControl	Menu control.
Public property	MenuControlPath	Menu control.
Public property	MenuID	Menu ID.
Public property	MenuParameter	Parameter for the menu control.
Public property	MouseButton	Mouse button.
Public property	OffsetX	Offset X of the menu.
Public property	OffsetY	Offset Y of the menu.
Public property	Parameter	Menu parameter.
Public property	ParentElementClientID	Identifier of parent element under which the context menu lies. This parameter is optional.
Public property	RenderAsTag	Specifies how the container should be rendered (as which tag).
Public property	ResourcePrefix	Prefix for the resource strings which will be used for the strings of the context menu. Default is "general".
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)
Public property	StopProcessing	Indicates if the control should perform the operations.
Public property	UIContext	Returns control's UI context (Inherited from CMSWebControl.)
Public property	VerticalPosition	Vertical position.