Click or drag to resize
CMSDocumentManager Methods

The CMSDocumentManager type exposes the following members.

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.)
Public methodApproveDocument
Approves document.
Public methodArchiveDocument
Archives document
Protected methodCheckDefaultConsistency
Checks the default consistency for the editing context
(Overrides CMSAbstractManagerEventArgsType, SimpleEventArgsTypeCheckDefaultConsistency(SimpleEventArgsType).)
Protected methodCheckDefaultSecurity
Checks the default security for the editing context
(Overrides CMSAbstractManagerEventArgsType, SimpleEventArgsTypeCheckDefaultSecurity(SimpleEventArgsType).)
Public methodCheckInDocument
Checks-in document
Public methodCheckOutDocument
Check-outs document
Public methodClearContentChanged
Clears content changed flag
Public methodClearNode
Clears current node.
Public methodClearProperties
Clears properties
(Overrides CMSAbstractManagerEventArgsType, SimpleEventArgsTypeClearProperties.)
Protected methodCreateChildControls
CreateChildControls event handler.
(Overrides ControlCreateChildControls.)
Public methodCreateNewVersion
Creates new document version. (Moves document to edit step.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEnsureDocumentsConsistency
Ensures documents consistency (Automatic blog post hierarchy etc.)
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 methodGetAllowSubmitScript
Gets allow submit script for save changes support
Protected methodGetDefaultCheckPermissionsError
Gets the default error message for check permission error
(Overrides CMSAbstractManagerEventArgsType, SimpleEventArgsTypeGetDefaultCheckPermissionsError(SimpleEventArgsType).)
Public methodGetDocumentInfo
Gets default document information text
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 methodGetJSSaveFunction
Gets java-script function for save action
Public methodGetSaveAndCloseScript
Gets script for save & close action
Public methodGetSaveAnotherScript
Gets script for save another action
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 methodHasLocalMessagesPlaceHolder
Indicates if local messages placeholder is used
Public methodIsActionAllowed
Checks if given action is allowed
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
(Overrides AbstractUserControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Overrides AbstractUserControlOnPreRender(EventArgs).)
Protected methodProcessAdditionalActions
Processes additional document actions (task logging, search index task creation...). Substitutes the actions from DocumentHelper if not used.
Public methodPublishDocument
Publishes document
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.)
Public methodRegisterRefreshScript
Sets the reload page attributes
Public methodRejectDocument(String)
Rejects document
Public methodRejectDocument(Int32, String)
Rejects document
Protected methodRender
Render action.
(Overrides AbstractUserControlRender(HtmlTextWriter).)
Public methodRenderScripts
Renders scripts
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSaveDocument
Saves document.
Protected methodSaveDocument(String)
Saves document. Content changed flag is cleared if document was saved.
Protected methodSaveDocumentInternal
Saves document.
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowDocumentInfo(Boolean)
Shows default document information text
Public methodShowDocumentInfo(Boolean, String)
Shows default document information text
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 methodUndoCheckOutDocument
Undoes check-out document
Public methodUpdateDocument
Updates the current document
Protected methodUpdateDocumentInternal
Updates the current document
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
See Also