Click or drag to resize
EditMenu Class
Base class for document edit menu control.
Inheritance Hierarchy

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 8.2.23
Syntax
C#
public abstract class EditMenu : BaseEditMenu

The EditMenu type exposes the following members.

Constructors
  NameDescription
Protected methodEditMenu
Top
Methods
  NameDescription
Protected methodAddAlert
Adds the alert message to the output request window.
(Inherited from BaseEditMenu.)
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddExtraAction
Adds the extra action to the menu
(Inherited from BaseEditMenu.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Protected methodAddScript
Adds the script to the output request window.
(Inherited from BaseEditMenu.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Protected methodEnsureSplitModeScript
Ensures java-script for split mode.
(Inherited from BaseEditMenu.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetString
Returns localized string.
(Inherited from AbstractUserControl.)
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
Load event handler.
(Inherited from AbstractUserControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Protected methodRaiseGetClientActionScript
Raises event to get client action script.
(Inherited from BaseEditMenu.)
Protected methodRaiseGetClientValidationScript
Raises event to get client validation script.
(Inherited from BaseEditMenu.)
Protected methodRaiseOnBeforeReloadMenu
Raises the OnBeforeReloadMenu when the ReloadMenu action is called.
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodCallHandled
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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Protected fieldmExtraActions
List of the extra actions added to the menu
(Inherited from BaseEditMenu.)
Protected fieldmViewStateTracked
If true, the ViewState has been already tracked.
(Inherited from InlineUserControl.)
Protected fieldproperties
Control properties.
(Inherited from InlineUserControl.)
Top
Properties
  NameDescription
Public propertyActionsValidationGroup
Name of validation group where action buttons belong to.
Public propertyAllowSave
Indicates if Save action is allowed.
(Inherited from BaseEditMenu.)
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyCultureCode
Document culture code.
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from AbstractUserControl.)
Public propertyEnabled
Indicates if the menu is enabled
(Inherited from BaseEditMenu.)
Public propertyForceArchive
Forces to show the Archive button (backward compatibility for basic workflow on Properties->Workflow tab).
Public propertyHandleWorkflow
Indicates if workflow actions should be displayed and handled
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyHideStandardButtons
If true, the menu shows the standard editing buttons
(Inherited from BaseEditMenu.)
Public propertyCheckPermissions
If true, the access permissions to the items are checked.
(Inherited from BaseEditMenu.)
Public propertyInformationText
If set, the given text is displayed as information text
(Inherited from BaseEditMenu.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyLinkCssClass
Link CSS class
(Inherited from BaseEditMenu.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyNode
Document node.
Public propertyNodeID
Node ID.
Public propertyOnClientStepChanged
Refresh script to be called when step ID of document changes
(Inherited from BaseEditMenu.)
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Public propertyRefreshInterval
Refresh interval
(Inherited from BaseEditMenu.)
Protected propertyResourceCulture
Resource strings culture
(Inherited from BaseEditMenu.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyShowApplyWorkflow
Show the Apply workflow button.
Public propertyShowApprove
Show the Approve button.
Public propertyShowArchive
Show the Archive button.
Public propertyShowCreateAnother
If true, create another button can be displayed.
Public propertyShowCreateWireframe
If true, the Create wireframe button is shown
Public propertyShowDelete
Show the Delete button.
Public propertyShowCheckIn
Show the Check In button.
Public propertyShowCheckOut
Show the Check Out button.
Public propertyShowProperties
Show the Properties button.
Public propertyShowReject
Show the Reject button.
Public propertyShowRemoveWireframe
If true, the Create wireframe button is shown
Public propertyShowSave
Show the Save button.
Public propertyShowSaveAndClose
If true, save and close button can be displayed
Public propertyShowSpellCheck
Show spell check button.
Public propertyShowSubmitToApproval
Show the Submit To Approval button.
Public propertyShowUndoCheckOut
Show the Undo CheckOut button.
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyUseSmallIcons
Indicates if small icons should be used for actions
(Inherited from BaseEditMenu.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Top
Events
  NameDescription
Public eventOnBeforeReloadMenu
Event raised when the ReloadMenu action is called.
Public eventOnGetClientActionScript
On get client action script handler.
(Inherited from BaseEditMenu.)
Public eventOnGetClientValidationScript
On get client validation script handler.
(Inherited from BaseEditMenu.)
Top
See Also