Click or drag to resize
CMSDocumentManager Class
Document manager.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UITemplateControl
      System.Web.UIUserControl
        CMS.Base.Web.UIAbstractUserControl
          CMS.FormEngine.Web.UICMSAbstractManagerDocumentManagerEventArgs, SimpleDocumentManagerEventArgs
            CMS.FormEngine.Web.UICMSDocumentManager

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.PortalEngine.Web.UI (in CMS.PortalEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class CMSDocumentManager : CMSAbstractManager<DocumentManagerEventArgs, SimpleDocumentManagerEventArgs>, 
	IPostBackEventHandler, ICMSDocumentManager

The CMSDocumentManager type exposes the following members.

Constructors
  NameDescription
Public methodCMSDocumentManager
Constructor.
Top
Fields
  NameDescription
Protected fieldhdnAnother
Hidden field for save action argument
Protected fieldhdnArgs
Hidden field for post back arguments
Protected fieldhdnClose
Hidden field for save & close action argument
Protected fieldhdnComment
Hidden field for comment argument
Protected fieldhdnContentChanged
Hidden field for content changed flag
Protected fieldhdnCurrStep
Hidden field for current step argument
Protected fieldhdnSaveChanges
Hidden field for save changes flag
Protected fieldplcMess
Messages placeholder
Protected fieldpnlDocumentInfo
Document info panel
Top
Properties
  NameDescription
Public propertyActionComment
Action comment
Public propertyAllowSave
Indicates if Save action is allowed.
Public propertyAutoCheck
Indicates if check-in/check-out functionality is automatic.
Public propertyCheckPermissions
Indicates if document permissions should be checked.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public propertyCloseDialog
Indicates whether dialog should be closed after action
Public propertyComponentName
Component name
(Overrides AbstractUserControlComponentName.)
Public propertyConfirmChanges
Indicates if confirm dialog should be displayed if any change to the document was made
Public propertyCreateAnother
Indicates if another document should be created after newly created.
Public propertyCultureCode
Culture code of document
Protected propertyCurrentDocument
Currently edited document
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Protected propertyCurrentStepArg
Hidden current step flag
Protected propertyCurrentStepID
Current step ID
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDataConsistent
Indicates if the data is consistent.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public propertyDocumentID
Document ID. Has higher priority than Node ID. Identifies edited document.
Public propertyDocumentInfo
Document information text.
Public propertyDocumentInfoLabel
Document information label.
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyDocumentPanel
Document info panel
Protected propertyStatic memberEditedDocument
Document edited by the current page. If set to NULL, redirects to the information page with information that document has been deleted.
Public propertyHandleWorkflow
Indicates if workflow actions should be displayed and handled
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Protected propertyHiddenAnotherFlag
Hidden save another flag
Protected propertyHiddenArguments
Hidden argument
Protected propertyHiddenCloseFlag
Hidden close flag
Protected propertyHiddenComment
Hidden comment field
Protected propertyHiddenContentChanged
Hidden content changed flag
Protected propertyHiddenSaveChanges
Hidden save changes flag
Public propertyInvariantNode
Returns current document in any culture.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyLoadDefaultValues
Indicates if default values should be loaded when new document or language version is being created.
Public propertyLocalDocumentPanel
Local document info panel
Public propertyLocalMessagesPlaceHolder
Local messages placeholder
Public propertyMessagesPlaceHolder
Messages placeholder
(Overrides AbstractUserControlMessagesPlaceHolder.)
Public propertyMode
Manager mode (Update, Insert, New culture version)
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public propertyNewNodeClass
Node class of the document type of new document.
Public propertyNewNodeClassID
Class ID of the document type of new document.
Public propertyNewNodeClassName
Class name of the document type of new document.
Public propertyNewNodeCultureCode
Node culture of new document.
Public propertyNextSteps
Next steps
Public propertyNode
Returns currently edited document if it is available in the given context.
Public propertyNodeID
Node ID. Together with DocumentCulture property identifies edited document.
Public propertyParentNode
Returns parent node for new document insertion.
Public propertyParentNodeID
Parent node ID. Indicates parent node for document insertion.
Public propertyProcessingAction
Indicates if workflow action is being processed
Public propertyRedirectForNonExistingDocument
Indicates if the UI should be redirected if document not found.
Public propertyRefreshActionContent
Indicates if content should be refreshed (action is being processed)
Public propertyRegisterEvents
Indicates if manager should register for common events (save etc.).
Public propertyRegisterSaveChangesScript
Indicates if the support script for save changes should be registered.
Public propertyRenderScript
Indicates if java script functions for document 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 propertySaveChanges
Returns true if the changes should be saved.
Public propertySetRedirectPageFlag
Indicates whether the page should be redirected to the current page which is being edited.
Public propertySetRefreshFlag
Indicates whether reload page property should be automatically added to the page for reload page functionality
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Protected propertySiteID
Gets site ID of the newly created document.
Public propertySiteName
Site name of the newly created document.
Public propertySourceDocumentID
Document ID of document language version, which should be used as a source data for new culture version.
Public propertySourceNode
Source document for new language version
Public propertyStep
Document workflow step.
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyTree
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Protected propertyUIContext
Control's UI Context
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
Public propertyUseDocumentHelper
Indicates if DocumentHelper should be used to manage the document (Use FALSE if modifying non-versioned properties.)
Public propertyUseFullFormSaveChanges
Indicates whether changes should be tracked for whole form or just for parts defined by data-tracksavechanges attribute.
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyVersionManager
Version manager instance.
Public propertyWorkflow
Document workflow.
Public propertyWorkflowManager
Gets Workflow 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.)
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 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
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 eventOnGetActionScript
Event to retrieve custom action script.
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