ContextMenuButton Class

Context menu icon.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.Base.Web.UI.ContextMenuContainer
          CMS.Base.Web.UI.ContextMenuButton

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 11.0.0

Syntax

public class ContextMenuButton : ContextMenuContainer

The ContextMenuButton type exposes the following members.

Constructors

	Name	Description
Public method	ContextMenuButton	Constructor.

Fields

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

Properties

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

Methods

	Name	Description
Protected method	CreateChildControls	Creates the child controls. (Overrides Control.CreateChildControls().)
Protected method	EnsureMenuControl	Ensures the menu control. (Inherited from ContextMenuContainer.)
Public method	InitializeMenuControl	Initializes menu control properties (Inherited from ContextMenuContainer.)
Protected method	OnInit	Control Init event. (Inherited from ContextMenuContainer.)
Protected method	OnLoad	Control Load event. (Inherited from ContextMenuContainer.)
Protected method	OnPreRender	Control PreRender event. (Inherited from ContextMenuContainer.)
Protected method	ReloadMenuData	Reload menu data. (Inherited from ContextMenuContainer.)
Protected method	Render	Control Render event. (Inherited from ContextMenuContainer.)
Public method	RenderBeginTag	Renders the begin tag of the control (Inherited from ContextMenuContainer.)
Public method	RenderEndTag	Renders the end tag of the control (Inherited from ContextMenuContainer.)
Public method	RenderStartTag	Renders the start tag for the menu container. (Inherited from ContextMenuContainer.)

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	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	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 ControlsExtensions.)
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.)