CMSObjectManager Class

Object manager control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.ExtendedControls.AbstractUserControl
          CMS.FormControls.CMSAbstractManager<SimpleObjectManagerEventArgs, SimpleObjectManagerEventArgs>
            CMS.FormControls.CMSObjectManager

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

Syntax

public class CMSObjectManager : CMSAbstractManager<SimpleObjectManagerEventArgs, SimpleObjectManagerEventArgs>, 
	ICMSObjectManager, IPostBackEventHandler

The CMSObjectManager type exposes the following members.

Constructors

	Name	Description
Public method	CMSObjectManager

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 (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Protected method	btnCommand_Click	Button click event
Public method	ClearProperties	Clears security result. (Overrides CMSAbstractManager<EventArgsType, SimpleEventArgsType>.ClearProperties().)
Protected method	CreateChildControls	CreateChildControls event handler. (Overrides Control.CreateChildControls().)
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.)
Public method Static member	GetCurrent	Gets the current instance of the object manager
Protected method	GetDefaultCheckPermissionsError	Gets the default error message for check permission error (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
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	GetJSFunction	Gets java-script function
Public method	GetString	Returns localized string. (Inherited from AbstractUserControl.)
Public method	GetSubmitScript	Gets submit script for save changes support
Public method Static member	GetUndoCheckOutConfirmation	Gets the undo check out confirmation message for the specified info. Takes info versioning support into account.
Protected method	CheckDefaultConsistency	Checks the default consistency for the editing context. (Overrides CMSAbstractManager<EventArgsType, SimpleEventArgsType>.CheckDefaultConsistency(SimpleEventArgsType).)
Protected method	CheckDefaultSecurity	Checks the default security for the editing context (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public method	CheckInAndSaveObject(String)	Checks the object in and saves it.
Public method	CheckInAndSaveObject(String, BaseInfo)	Checks the object in and saves it.
Public method	CheckInObject(String)	Checks the object in.
Public method	CheckInObject(String, BaseInfo)	Checks the object in.
Public method Static member	CheckOutNewObject	Finds current object manager and uses it to checkout current object.
Public method	CheckOutObject()	Checks the object out.
Public method	CheckOutObject(BaseInfo)	Checks the object out.
Public method	IsActionAllowed	Checks if given action is allowed.
Public method	IsObjectChecked	Returns true if object is checked out or use checkin/out is not used
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 (Overrides AbstractUserControl.OnInit(EventArgs).)
Protected method	OnLoad	OnLoad event (Overrides AbstractUserControl.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Inherited from AbstractUserControl.)
Protected method	RaiseAfterAction	Raises event after action (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Protected method	RaiseBeforeAction	Raises event before action (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Protected method	RaiseCheckConsistency	Raises event to check consistency (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Protected method	RaiseCheckPermissions	Raises event to check permissions (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Protected method	RaiseLoadData	Raises event to load data (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public method	RaisePostBackEvent	Raises the post back event.
Protected method	RaiseSaveData	Raises event to get data to save (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Protected method	RaiseSaveFailed	Raises event when saving data fails (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Protected method	RaiseValidateData	Raises event to validate data (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Protected method	Render	Render action. (Overrides AbstractUserControl.Render(HtmlTextWriter).)
Public method	RenderScripts	Renders scripts
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	SaveObject()	Saves the object.
Public method	SaveObject(SimpleObjectManagerEventArgs)	Saves the object.
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.)
Public method	UndoCheckOutObject()	Cancels the object checkout.
Public method	UndoCheckOutObject(BaseInfo)	Cancels the object checkout.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
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	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	btnCommand	Button for launching partial postback
Protected field	hdnComment	Hidden field for comment argument.
Protected field	mInfoObject	Object with which the manager is working.
Protected field	mVersionManager	Object version manager instance.

Properties

	Name	Description
Public property	ActionComment	Action comment (for CheckIn operation).
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. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
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.)
Protected property	HiddenComment	Hidden comment field.
Public property	CheckPermissions	Indicates if document permissions should be checked. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public property	InfoObject	Returns object with which the manager is working. It return the object based on ObjectType nd ObjectID properties, if these properties are not present, checks if the EditedObject is present.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property Static member	KeepNewObjectsCheckedOut	Returns true if CMSUseObjectCheckinCheckout and CMSKeepNewCheckedOut are true.
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	Mode	Manager mode (Update, Insert, New culture version) (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public property	ObjectID	ID of the object. Taken into account only if EditedObject is null.
Public property	ObjectType	Object type of the object. Taken into account only if EditedObject is null.
Public property	RegisterEvents	Indicates if manager should register for common events (save etc.).
Public property	RenderScript	Indicates if java script functions for object management should be rendered.
Public property	ResourceCulture	Resource strings culture (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	ShowPanel	Indicates if the object locking panel should be showed.
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.)
Public property	VersionManager	Object version manager instance.

Events

	Name	Description
Public event	OnAfterAction	On after action event handler. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public event	OnBeforeAction	On before action event handler. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public event	OnCheckConsistency	On check consistency event handler. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public event	OnCheckPermissions	On check permissions event handler. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public event	OnLoadData	On load data event handler. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public event	OnSaveData	On save data event handler. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public event	OnSaveFailed	Occurs when saving data fails. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public event	OnValidateData	On data validation event handler. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)