Click or drag to resize
CMSAbstractManagerEventArgsType, SimpleEventArgsType Class
Base class for managers
Inheritance Hierarchy

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 10.0.0
Syntax
C#
public abstract class CMSAbstractManager<EventArgsType, SimpleEventArgsType> : AbstractUserControl
where EventArgsType : ManagerEventArgs
where SimpleEventArgsType : ManagerEventArgs

Type Parameters

EventArgsType
SimpleEventArgsType

The CMSAbstractManagerEventArgsType, SimpleEventArgsType type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
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 propertyDataConsistent
Indicates if the data is consistent.
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyCheckPermissions
Indicates if document permissions should be checked.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyMode
Manager mode (Update, Insert, New culture version)
Public propertyResourceCulture
Resource strings culture
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Protected propertyUIContext
Control's UI Context
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Top
Methods
  NameDescription
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 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 methodAddText
Adds additional text
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodClearProperties
Clears properties
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
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.)
Protected methodGetDefaultCheckPermissionsError
Gets the default error message for check permission error
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 the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Protected methodCheckDefaultConsistency
Checks the default consistency for the editing context
Protected methodCheckDefaultSecurity
Checks the default security for the editing context
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
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 methodRaiseAfterAction
Raises event after action
Protected methodRaiseBeforeAction
Raises event before action
Protected methodRaiseCheckConsistency
Raises event to check consistency
Protected methodRaiseCheckPermissions
Raises event to check permissions
Protected methodRaiseLoadData
Raises event to load data
Protected methodRaiseSaveData
Raises event to get data to save
Protected methodRaiseSaveFailed
Raises event when saving data fails
Protected methodRaiseValidateData
Raises event to validate data
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
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.)
Top
Extension Methods
  NameDescription
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventOnAfterAction
On after action event handler.
Public eventOnBeforeAction
On before action event handler.
Public eventOnCheckConsistency
On check consistency event handler.
Public eventOnCheckPermissions
On check permissions event handler.
Public eventOnLoadData
On load data event handler.
Public eventOnSaveData
On save data event handler.
Public eventOnSaveFailed
Occurs when saving data fails.
Public eventOnValidateData
On data validation event handler.
Top
See Also