Click or drag to resize
CMSObjectManager Class
Object manager control.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIUserControl
        CMS.Base.Web.UIAbstractUserControl
          CMS.FormEngine.Web.UICMSAbstractManagerSimpleObjectManagerEventArgs, SimpleObjectManagerEventArgs
            CMS.FormEngine.Web.UICMSObjectManager

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class CMSObjectManager : CMSAbstractManager<SimpleObjectManagerEventArgs, SimpleObjectManagerEventArgs>, 
	ICMSObjectManager, IPostBackEventHandler

The CMSObjectManager type exposes the following members.

Constructors
  NameDescription
Public methodCMSObjectManager
Top
Fields
  NameDescription
Protected fieldbtnCommand
Button for launching partial postback
Protected fieldhdnComment
Hidden field for comment argument.
Protected fieldmInfoObject
Object with which the manager is working.
Protected fieldmVersionManager
Object version manager instance.
Top
Properties
  NameDescription
Public propertyActionComment
Action comment (for CheckIn operation).
Public propertyCheckPermissions
Indicates if document permissions should be checked.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public propertyComponentName
Component name
(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.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Protected propertyHiddenComment
Hidden comment field.
Public propertyInfoObject
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 propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyStatic memberKeepNewObjectsCheckedOut
Returns true if CMSUseObjectCheckinCheckout and CMSKeepNewCheckedOut are true.
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyMode
Manager mode (Update, Insert, New culture version)
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public propertyObjectID
ID of the object. Taken into account only if EditedObject is null.
Public propertyObjectType
Object type of the object. Taken into account only if EditedObject is null.
Public propertyRegisterEvents
Indicates if manager should register for common events (save etc.).
Public propertyRenderScript
Indicates if java script functions for object management should be rendered.
Public propertyResourceCulture
Resource strings culture
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
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 propertyShowPanel
Indicates if the object locking panel should be showed.
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Protected propertyUIContext
Control's UI Context
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyVersionManager
Object version manager instance.
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
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Protected methodbtnCommand_Click
Button click event
Protected methodCheckDefaultConsistency
Checks the default consistency for the editing context.
(Overrides CMSAbstractManagerEventArgsType, SimpleEventArgsTypeCheckDefaultConsistency(SimpleEventArgsType).)
Protected methodCheckDefaultSecurity
Checks the default security for the editing context
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public methodCheckInAndSaveObject(String)
Checks the object in and saves it.
Public methodCheckInAndSaveObject(String, BaseInfo)
Checks the object in and saves it.
Public methodCheckInObject(String)
Checks the object in.
Public methodCheckInObject(String, BaseInfo)
Checks the object in.
Public methodStatic memberCheckOutNewObject
Finds current object manager and uses it to checkout current object.
Public methodCheckOutObject
Checks the object out.
Public methodCheckOutObject(BaseInfo)
Checks the object out.
Public methodClearProperties
Clears security result.
(Overrides CMSAbstractManagerEventArgsType, SimpleEventArgsTypeClearProperties.)
Protected methodCreateChildControls
CreateChildControls event handler.
(Overrides ControlCreateChildControls.)
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 methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(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 methodStatic memberGetCurrent
Gets the current instance of the object manager
Protected methodGetDefaultCheckPermissionsError
Gets the default error message for check permission error
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
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 methodGetJSFunction
Gets java-script function
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.)
Public methodGetSubmitScript
Gets submit script for save changes support
Public methodStatic memberGetUndoCheckOutConfirmation
Gets the undo check out confirmation message for the specified info. Takes info versioning support into account.
Public methodIsActionAllowed
Checks if given action is allowed.
Public methodIsObjectChecked
Returns true if object is checked out or use checkin/out is not used
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
(Overrides AbstractUserControlOnInit(EventArgs).)
Protected methodOnLoad
OnLoad event
(Overrides AbstractUserControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Protected methodRaiseAfterAction
Raises event after action
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Protected methodRaiseBeforeAction
Raises event before action
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Protected methodRaiseCheckConsistency
Raises event to check consistency
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Protected methodRaiseCheckPermissions
Raises event to check permissions
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Protected methodRaiseLoadData
Raises event to load data
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public methodRaisePostBackEvent
Raises the post back event.
Protected methodRaiseSaveData
Raises event to get data to save
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Protected methodRaiseSaveFailed
Raises event when saving data fails
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Protected methodRaiseValidateData
Raises event to validate data
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Protected methodRender
Render action.
(Overrides AbstractUserControlRender(HtmlTextWriter).)
Public methodRenderScripts
Renders scripts
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSaveObject
Saves the object.
Public methodSaveObject(SimpleObjectManagerEventArgs)
Saves the object.
Public methodShowChangesSaved
Shows the general changes saved message.
(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 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.)
Public methodUndoCheckOutObject
Cancels the object checkout.
Public methodUndoCheckOutObject(BaseInfo)
Cancels the object checkout.
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.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public eventOnBeforeAction
On before action event handler.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public eventOnCheckConsistency
On check consistency event handler.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public eventOnCheckPermissions
On check permissions event handler.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public eventOnLoadData
On load data event handler.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public eventOnSaveData
On save data event handler.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public eventOnSaveFailed
Occurs when saving data fails.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public eventOnValidateData
On data validation event handler.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Top
See Also