ContextMenu Class

Context menu control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.Panel
        CMS.Base.Web.UI.CMSPanel
          CMS.Base.Web.UI.ContextMenu

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

Syntax

public class ContextMenu : CMSPanel, 
	ICallbackEventHandler

The ContextMenu type exposes the following members.

Constructors

	Name	Description
Public method	ContextMenu	Constructor

Fields

	Name	Description
Public field Static member	CONTEXT_MENU_SUFFIX	Context menu suffix.
Protected field	mContainerUniqueID	Container unique ID.
Protected field	mContextMenuControl	Context menu control.
Protected field	mHorizontalPosition	Horizontal position.
Protected field	mMenuID	Menu ID.
Protected field	mMouseButton	Mouse button.
Protected field	mParameter	Menu parameter.
Protected field	mResourcePrefix	Prefix for the resource strings which will be used for the strings of the context menu.
Protected field	mShowTimeout	Timeout to show the menu until it disappears.
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	ActiveItemOffset	Determines how many levels above the clicked element the active element is.
Public property	Collapsible	Determines whether is possible to collapse the panel by clicking its grouping text. (Inherited from CMSPanel.)
Public property	ContainerUniqueID	Container unique ID.
Public property	ContextMenuControl	Context menu control.
Public property	Dynamic	Determines whether to load the menu dynamically.
Public property	FixedParentClientID	Parent client ID to be used for fixed panels placeholders (Inherited from CMSPanel.)
Public property	FixedPosition	Indicates if panel should be always on top of a page. (Inherited from CMSPanel.)
Public property	GroupingTextResourceString	Resource string for the grouping text (Inherited from CMSPanel.)
Public property	HorizontalPosition	Horizontal position.
Public property	IsCollapsed	Initial collapsed state. (Inherited from CMSPanel.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSPanel.)
Public property	LoadingContent	Content displayed during loading.
Public property	MenuID	Menu ID, must be unique within page context.
Public property	MenuLevel	Menu level.
Public property	MouseButton	Mouse button.
Public property	OffsetX	Offset X of the menu.
Public property	OffsetY	Offset Y of the menu.
Public property	OpenUp	If true, the menu opens in the upward direction instead down
Public property	OuterCssClass	CSS Class for the outer envelope 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	RenderChildrenOnly	If true, only child controls are render to the output (Inherited from CMSPanel.)
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 CMSPanel.)
Public property	ShowMenuOnMouseOver	Show menu on mouse over action?
Public property	ShowTimeout	Timeout to show the menu until it disappears.
Public property	VerticalPosition	Vertical position.

Methods

	Name	Description
Public method	GetCallbackResult	Returns the callback result.
Public method	LoadUserControl	Loads the specified control to the menu.
Protected method	OnInit	Init event handler. (Inherited from CMSPanel.)
Protected method	OnPreRender	Control PreRender event. (Overrides CMSPanel.OnPreRender(EventArgs).)
Public method	RaiseCallbackEvent	Raises the callback event.
Protected method	Render	Renders the control. (Overrides CMSPanel.Render(HtmlTextWriter).)

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

Events

	Name	Description
Public event	OnReloadData	Raised when the menu requires to reload its data (for dynamic menus).