CMSAbstractManager<EventArgsType, SimpleEventArgsType> Class

Base class for managers

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.ExtendedControls.AbstractUserControl
          CMS.FormControls.CMSAbstractManager<EventArgsType, SimpleEventArgsType>
            CMS.FormControls.CMSAutomationManager
            CMS.FormControls.CMSDocumentManager
            CMS.FormControls.CMSObjectManager

Namespace: CMS.FormControls
Assembly: CMS.FormControls (in CMS.FormControls.dll) Version: 9.0.0

Syntax

public abstract class CMSAbstractManager<EventArgsType, SimpleEventArgsType> : AbstractUserControl
where EventArgsType : ManagerEventArgs
where SimpleEventArgsType : ManagerEventArgs

Type Parameters

EventArgsType

SimpleEventArgsType

The CMSAbstractManager<EventArgsType, SimpleEventArgsType> type exposes the following members.

Constructors

	Name	Description
Protected method	CMSAbstractManager<EventArgsType, SimpleEventArgsType>

Properties

	Name	Description
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
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	DataConsistent	Indicates if the data is consistent.
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object (Inherited from AbstractUserControl.)
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	CheckPermissions	Indicates if document permissions should be checked.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	Mode	Manager mode (Update, Insert, New culture version)
Public property	ResourceCulture	Resource strings culture
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	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	UIContext	Control's UI Context (Inherited from AbstractUserControl.)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)

Methods

	Name	Description
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	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	AddText	Adds additional text
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	ClearProperties	Clears properties
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
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	EvalDouble	Evaluates the item data and converts it to the integer. (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.)
Protected method	GetDefaultCheckPermissionsError	Gets the default error message for check permission error
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.)
Protected method	CheckDefaultConsistency	Checks the default consistency for the editing context
Protected method	CheckDefaultSecurity	Checks the default security for the editing context
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.)
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	RaiseAfterAction	Raises event after action
Protected method	RaiseBeforeAction	Raises event before action
Protected method	RaiseCheckConsistency	Raises event to check consistency
Protected method	RaiseCheckPermissions	Raises event to check permissions
Protected method	RaiseLoadData	Raises event to load data
Protected method	RaiseSaveData	Raises event to get data to save
Protected method	RaiseSaveFailed	Raises event when saving data fails
Protected method	RaiseValidateData	Raises event to validate data
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	ResolveUrl	Resolves the given URL (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	ShowChangesSaved	Shows the general changes saved message. (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.)

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	OnAfterAction	On after action event handler.
Public event	OnBeforeAction	On before action event handler.
Public event	OnCheckConsistency	On check consistency event handler.
Public event	OnCheckPermissions	On check permissions event handler.
Public event	OnLoadData	On load data event handler.
Public event	OnSaveData	On save data event handler.
Public event	OnSaveFailed	Occurs when saving data fails.
Public event	OnValidateData	On data validation event handler.