CMSDocumentManager Class

Document manager.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.ExtendedControls.AbstractUserControl
          CMS.FormControls.CMSAbstractManager<DocumentManagerEventArgs, SimpleDocumentManagerEventArgs>
            CMS.FormControls.CMSDocumentManager

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

Syntax

public class CMSDocumentManager : CMSAbstractManager<DocumentManagerEventArgs, SimpleDocumentManagerEventArgs>, 
	IPostBackEventHandler, ICMSDocumentManager

The CMSDocumentManager type exposes the following members.

Constructors

	Name	Description
Public method	CMSDocumentManager	Constructor.

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.)
Public method	ApproveDocument	Approves document.
Public method	ArchiveDocument	Archives document
Public method	ClearContentChanged	Clears content changed flag
Public method	ClearNode	Clears current node.
Public method	ClearProperties	Clears properties (Overrides CMSAbstractManager<EventArgsType, SimpleEventArgsType>.ClearProperties().)
Protected method	CreateChildControls	CreateChildControls event handler. (Overrides Control.CreateChildControls().)
Public method	CreateNewVersion	Creates new document version. (Moves document to edit step.)
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	EnsureDocumentsConsistency	Ensures documents consistency (Automatic blog post hierarchy etc.)
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	GetAllowSubmitScript	Gets allow submit script for save changes support
Protected method	GetDefaultCheckPermissionsError	Gets the default error message for check permission error (Overrides CMSAbstractManager<EventArgsType, SimpleEventArgsType>.GetDefaultCheckPermissionsError(SimpleEventArgsType).)
Public method	GetDocumentInfo	Gets default document information text
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	GetJSSaveFunction	Gets java-script function for save action
Public method	GetSaveAndCloseScript	Gets script for save & close action
Public method	GetSaveAnotherScript	Gets script for save another action
Public method	GetString	Returns localized string. (Inherited from AbstractUserControl.)
Public method	GetSubmitScript	Gets submit script for save changes support
Public method	HasLocalMessagesPlaceHolder	Indicates if local messages placeholder is used
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 (Overrides CMSAbstractManager<EventArgsType, SimpleEventArgsType>.CheckDefaultSecurity(SimpleEventArgsType).)
Public method	CheckInDocument	Checks-in document
Public method	CheckOutDocument	Check-outs document
Public method	IsActionAllowed	Checks if given action is allowed
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 (Overrides AbstractUserControl.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Overrides AbstractUserControl.OnPreRender(EventArgs).)
Protected method	ProcessAdditionalActions	Processes additional document actions (task logging, search index task creation...). Substitutes the actions from DocumentHelper if not used.
Public method	PublishDocument	Publishes document
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>.)
Public method	RegisterRefreshScript	Sets the reload page attributes
Public method	RejectDocument(String)	Rejects document
Public method	RejectDocument(Int32, String)	Rejects document
Public method	RemoveWireframe	Removes the wireframe from current document
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	SaveDocument()	Saves document.
Protected method	SaveDocument(String)	Saves document. Content changed flag is cleared if document was saved.
Protected method	SaveDocumentInternal	Saves document.
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowDocumentInfo(Boolean)	Shows default document information text
Public method	ShowDocumentInfo(Boolean, String)	Shows default document information text
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	UndoCheckOutDocument	Undoes check-out document
Public method	UpdateDocument	Updates the current document
Protected method	UpdateDocumentInternal	Updates the current document

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	hdnAnother	Hidden field for save action argument
Protected field	hdnArgs	Hidden field for post back arguments
Protected field	hdnClose	Hidden field for save & close action argument
Protected field	hdnComment	Hidden field for comment argument
Protected field	hdnContentChanged	Hidden field for content changed flag
Protected field	hdnCurrStep	Hidden field for current step argument
Protected field	hdnSaveChanges	Hidden field for save changes flag
Protected field	plcMess	Messages placeholder
Protected field	pnlDocumentInfo	Document info panel

Properties

	Name	Description
Public property	ActionComment	Action comment
Public property	AllowSave	Indicates if Save action is allowed.
Public property	AutoCheck	Indicates if check-in/check-out functionality is automatic.
Public property	CloseDialog	Indicates whether dialog should be closed after action
Public property	ComponentName	Component name (Overrides AbstractUserControl.ComponentName.)
Public property	ConfirmChanges	Indicates if confirm dialog should be displayed if any change to the document was made
Public property	CreateAnother	Indicates if another document should be created after newly created.
Public property	CultureCode	Culture code of document
Protected property	CurrentDocument	Currently edited document
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Protected property	CurrentStepArg	Hidden current step flag
Protected property	CurrentStepID	Current step ID
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DataConsistent	Indicates if the data is consistent. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public property	DocumentID	Document ID. Has higher priority than Node ID. Identifies edited document.
Public property	DocumentInfo	Document information text.
Public property	DocumentInfoLabel	Document information label.
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	DocumentPanel	Document info panel
Protected property Static member	EditedDocument	Document edited by the current page. If set to NULL, redirects to the information page with information that document has been deleted.
Public property	EditedObject	Control's edited object (Inherited from AbstractUserControl.)
Public property	GroupID	Community group ID
Public property	HandleWorkflow	Indicates if workflow actions should be displayed and handled
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Protected property	HiddenAnotherFlag	Hidden save another flag
Protected property	HiddenArguments	Hidden argument
Protected property	HiddenCloseFlag	Hidden close flag
Protected property	HiddenComment	Hidden comment field
Protected property	HiddenContentChanged	Hidden content changed flag
Protected property	HiddenSaveChanges	Hidden save changes flag
Public property	CheckPermissions	Indicates if document permissions should be checked. (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public property	InvariantNode	Returns current document in any culture.
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	LoadDefaultValues	Indicates if default values should be loaded when new document or language version is being created.
Public property	LocalDocumentPanel	Local document info panel
Public property	LocalMessagesPlaceHolder	Local messages placeholder
Public property	MessagesPlaceHolder	Messages placeholder (Overrides AbstractUserControl.MessagesPlaceHolder.)
Public property	Mode	Manager mode (Update, Insert, New culture version) (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public property	NewNodeClass	Node class of the document type of new document.
Public property	NewNodeClassID	Class ID of the document type of new document.
Public property	NewNodeClassName	Class name of the document type of new document.
Public property	NewNodeCultureCode	Node culture of new document.
Public property	NextSteps	Next steps
Public property	Node	Returns currently edited document if it is available in the given context.
Public property	NodeID	Node ID. Together with DocumentCulture property identifies edited document.
Public property	ParentNode	Returns parent node for new document insertion.
Public property	ParentNodeID	Parent node ID. Indicates parent node for document insertion.
Public property	ProcessingAction	Indicates if workflow action is being processed
Public property	RedirectForNonExistingDocument	Indicates if the UI should be redirected if document not found.
Public property	RefreshActionContent	Indicates if content should be refreshed (action is being processed)
Public property	RegisterEvents	Indicates if manager should register for common events (save etc.).
Public property	RegisterSaveChangesScript	Indicates if the support script for save changes should be registered.
Public property	RenderScript	Indicates if java script functions for document management should be rendered.
Public property	ResourceCulture	Resource strings culture (Inherited from CMSAbstractManager<EventArgsType, SimpleEventArgsType>.)
Public property	SaveChanges	Returns true if the changes should be saved.
Public property	SetRedirectPageFlag	Indicates whether the page should be redirected to the current page which is being edited.
Public property	SetRefreshFlag	Indicates whether reload page property should be automatically added to the page for reload page functionality
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Protected property	SiteID	Gets site ID of the newly created document.
Public property	SiteName	Site name of the newly created document.
Public property	SourceDocumentID	Document ID of document language version, which should be used as a source data for new culture version.
Public property	SourceNode	Source document for new language version
Public property	Step	Document workflow step.
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	Tree	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public property	UIContext	Control's UI Context (Inherited from AbstractUserControl.)
Public property	UseDocumentHelper	Indicates if DocumentHelper should be used to manage the document (Use FALSE if modifying non-versioned properties.)
Public property	UseFullFormSaveChanges	Indicates whether changes should be tracked for whole form or just for parts defined by data-tracksavechanges attribute.
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Public property	VersionManager	Version manager instance.
Public property	Workflow	Document workflow.
Public property	WorkflowManager	Gets Workflow 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>.)