EditMenu Class

Base class for document edit menu control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.Base.Web.UI.InlineUserControl
            CMS.PortalEngine.Web.UI.BaseEditMenu
              CMS.PortalEngine.Web.UI.EditMenu

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

Syntax

public abstract class EditMenu : BaseEditMenu

The EditMenu type exposes the following members.

Constructors

	Name	Description
Protected method	EditMenu

Fields

	Name	Description
Protected field	mExtraActions	List of the extra actions added to the menu (Inherited from BaseEditMenu.)

Properties

	Name	Description
Public property	ActionsValidationGroup	Name of validation group where action buttons belong to.
Public property	AllowSave	Indicates if Save action is allowed. (Inherited from BaseEditMenu.)
Public property	CheckPermissions	If true, the access permissions to the items are checked. (Inherited from BaseEditMenu.)
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	CultureCode	Document culture code.
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	Enabled	Indicates if the menu is enabled (Inherited from BaseEditMenu.)
Public property	ForceArchive	Forces to show the Archive button (backward compatibility for basic workflow on Properties->Workflow tab).
Public property	HandleWorkflow	Indicates if workflow actions should be displayed and handled
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	HideStandardButtons	If true, the menu shows the standard editing buttons (Inherited from BaseEditMenu.)
Public property	InformationText	If set, the given text is displayed as information text (Inherited from BaseEditMenu.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	Item	Gets or sets the value of the column. (Inherited from InlineUserControl.)
Public property	LinkCssClass	Link CSS class (Inherited from BaseEditMenu.)
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	Node	Document node.
Public property	NodeID	Node ID.
Public property	OnClientStepChanged	Refresh script to be called when step ID of document changes (Inherited from BaseEditMenu.)
Public property	Parameter	Control parameter. (Inherited from InlineUserControl.)
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	RefreshInterval	Refresh interval (Inherited from BaseEditMenu.)
Protected property	ResourceCulture	Resource strings culture (Inherited from BaseEditMenu.)
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls. (Inherited from AbstractUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	ShowApplyWorkflow	Show the Apply workflow button.
Public property	ShowApprove	Show the Approve button.
Public property	ShowArchive	Show the Archive button.
Public property	ShowCheckIn	Show the Check In button.
Public property	ShowCheckOut	Show the Check Out button.
Public property	ShowCreateAnother	If true, create another button can be displayed.
Public property	ShowDelete	Show the Delete button.
Public property	ShowProperties	Show the Properties button.
Public property	ShowReject	Show the Reject button.
Public property	ShowSave	Show the Save button.
Public property	ShowSaveAndClose	If true, save and close button can be displayed
Public property	ShowSpellCheck	Show spell check button.
Public property	ShowSubmitToApproval	Show the Submit To Approval button.
Public property	ShowUndoCheckOut	Show the Undo CheckOut button.
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Public property	UseSmallIcons	Indicates if small icons should be used for actions (Inherited from BaseEditMenu.)
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)

Methods

	Name	Description
Protected method	AddAlert	Adds the alert message to the output request window. (Inherited from BaseEditMenu.)
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddExtraAction	Adds the extra action to the menu (Inherited from BaseEditMenu.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Protected method	AddScript	Adds the script to the output request window. (Inherited from BaseEditMenu.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Protected method	EnsureSplitModeScript	Ensures java-script for split mode. (Inherited from BaseEditMenu.)
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDecimal	Evaluates the item data and converts it to the decimal. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the double. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Public method	GetValue(String)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	HasValue	Returns true if the value of the given property is set. (Inherited from InlineUserControl.)
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	OnContentLoaded	Method that is called when the control content is loaded. (Inherited from InlineUserControl.)
Protected method	OnInit	Init event handler. (Inherited from AbstractUserControl.)
Protected method	OnLoad	Load event handler. (Inherited from AbstractUserControl.)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Protected method	RaiseGetClientActionScript	Raises event to get client action script. (Inherited from BaseEditMenu.)
Protected method	RaiseGetClientValidationScript	Raises event to get client validation script. (Inherited from BaseEditMenu.)
Protected method	RaiseOnBeforeReloadMenu	Raises the OnBeforeReloadMenu when the ReloadMenu action is called.
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from InlineUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)

Extension Methods

	Name	Description
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	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnBeforeReloadMenu	Event raised when the ReloadMenu action is called.
Public event	OnGetClientActionScript	On get client action script handler. (Inherited from BaseEditMenu.)
Public event	OnGetClientValidationScript	On get client validation script handler. (Inherited from BaseEditMenu.)