ICMSDocumentManager Interface

Document manager interface.

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 10.0.0

Syntax

public interface ICMSDocumentManager

The ICMSDocumentManager type exposes the following members.

Properties

	Name	Description
Public property	AllowSave	Indicates if document can be saved within current context
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
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
Public property	DataConsistent	Indicates if the data is consistent.
Public property	DocumentID	Document ID. Identifies edited document. Alternative to NodeID and CultureCode with higher priority.
Public property	DocumentInfo	Document information text
Public property	DocumentInfoLabel	Document information label.
Public property	DocumentPanel	Document info panel
Public property	GroupID	Community group ID
Public property	HandleWorkflow	Indicates if workflow actions should be displayed and handled
Public property	CheckPermissions	Indicates if document permissions should be checked.
Public property	InvariantNode	Returns current document in any culture.
Public property	IsLiveSite	Indicates if control is used on live site.
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 to override
Public property	LocalMessagesPlaceHolder	Local messages placeholder to override
Public property	MessagesPlaceHolder	Messages placeholder
Public property	Mode	Manager mode (Update, Insert, New culture version)
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 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	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	SiteName	Site name.
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 stop processing
Public property	Tree	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
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	VersionManager	Version manager instance.
Public property	Workflow	Document workflow.
Public property	WorkflowManager	Gets Workflow manager instance.

Methods

	Name	Description
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
Public method	EnsureDocumentsConsistency	Ensures documents consistency (Automatic blog post hierarchy etc.)
Public method	GetAllowSubmitScript	Gets allow submit script for save changes support
Public method	GetDocumentInfo	Gets default document information text
Public method	GetJSFunction	Gets java-script function
Public method	GetJSSaveFunction	Gets java-script function for save action
Public method	GetSaveAndCloseScript	Gets script for close dialog action
Public method	GetSaveAnotherScript	Gets script for save another action
Public method	GetSubmitScript	Gets submit script for save changes support
Public method	HasLocalMessagesPlaceHolder	Indicates if local messages placeholder is used
Public method	CheckInDocument	Checks-in document
Public method	CheckOutDocument	Check-outs document
Public method	IsActionAllowed	Checks if given action is allowed
Public method	PublishDocument	Publishes document
Public method	RejectDocument	Rejects document
Public method	RenderScripts	Renders scripts
Public method	SaveDocument	Saves document.
Public method	ShowDocumentInfo(Boolean)	Gets document information text
Public method	ShowDocumentInfo(Boolean, String)	Shows default document information text
Public method	UndoCheckOutDocument	Undoes check-out document
Public method	UpdateDocument	Updates the current document

Events

	Name	Description
Public event	OnAfterAction	On after action event handler.
Public event	OnBeforeAction	On before action event handler.
Public event	OnCheckConsistency	On check consistency event handler.
Public event	OnCheckPermissions	On check permissions event handler.
Public event	OnLoadData	On load data event handler.
Public event	OnSaveData	On save data event handler.
Public event	OnSaveFailed	Occurs when saving data fails.
Public event	OnValidateData	On data validation event handler.