The ICMSDocumentManager type exposes the following members.
Back to Top
Back to Top
Back to Top
Methods
| Name | Description | |
|---|---|---|
| ApproveDocument | 
            Approves document.
              | |
| ArchiveDocument | 
            Archives document
              | |
| ClearContentChanged | 
            Clears content changed flag
              | |
| ClearNode | 
            Clears current node.
              | |
| ClearProperties | 
            Clears properties
              | |
| EnsureDocumentsConsistency | 
            Ensures documents consistency (Automatic blog post hierarchy etc.)
              | |
| GetAllowSubmitScript | 
            Gets allow submit script for save changes support
              | |
| GetDocumentInfo | 
            Gets default document information text
              | |
| GetJSFunction | 
            Gets java-script function
              | |
| GetJSSaveFunction | 
            Gets java-script function for save action
              | |
| GetSaveAndCloseScript | 
            Gets script for close dialog action
              | |
| GetSaveAnotherScript | 
            Gets script for save another action
              | |
| GetSubmitScript | 
            Gets submit script for save changes support
              | |
| HasLocalMessagesPlaceHolder | 
            Indicates if local messages placeholder is used
              | |
| CheckInDocument | 
            Checks-in document
              | |
| CheckOutDocument | 
            Check-outs document
              | |
| IsActionAllowed | 
            Checks if given action is allowed
              | |
| PublishDocument | 
            Publishes document
              | |
| RejectDocument | 
            Rejects document
              | |
| RemoveWireframe | 
            Removes the wireframe from current document
              | |
| RenderScripts | 
            Renders scripts
              | |
| SaveDocument | 
            Saves document.
              | |
| ShowDocumentInfo(Boolean) | 
            Gets document information text
              | |
| ShowDocumentInfo(Boolean, String) | 
            Shows default document information text
              | |
| UndoCheckOutDocument | 
            Undoes check-out document
              | |
| UpdateDocument | 
            Updates the current document
              | 
Properties
| Name | Description | |
|---|---|---|
| AllowSave | 
            Indicates if document can be saved within current context
              | |
| AutoCheck | 
            Indicates if check-in/check-out functionality is automatic.
              | |
| CloseDialog | 
            Indicates whether dialog should be closed after action
              | |
| ComponentName | 
            Component name
              | |
| ConfirmChanges | 
            Indicates if confirm dialog should be displayed if any change to the document was made
              | |
| CreateAnother | 
            Indicates if another document should be created after newly created.
              | |
| CultureCode | 
            Culture code of document
              | |
| DataConsistent | 
            Indicates if the data is consistent.
              | |
| DocumentID | 
            Document ID. Identifies edited document. Alternative to NodeID and CultureCode with higher priority.
              | |
| DocumentInfo | 
            Document information text
              | |
| DocumentInfoLabel | 
            Document information label.
              | |
| DocumentPanel | 
            Document info panel
              | |
| GroupID | 
            Community group ID
              | |
| HandleWorkflow | 
            Indicates if workflow actions should be displayed and handled
              | |
| CheckPermissions | 
            Indicates if document permissions should be checked.
              | |
| InvariantNode | 
            Returns current document in any culture.
              | |
| IsLiveSite | 
            Indicates if control is used on live site.
              | |
| LoadDefaultValues | 
            Indicates if default values should be loaded when new document or language version is being created.
              | |
| LocalDocumentPanel | 
            Local document info panel to override 
              | |
| LocalMessagesPlaceHolder | 
            Local messages placeholder to override 
              | |
| MessagesPlaceHolder | 
            Messages placeholder
              | |
| Mode | 
            Manager mode (Update, Insert, New culture version)
              | |
| NewNodeClass | 
            Node class of the document type of new document.
              | |
| NewNodeClassID | 
            Class ID of the document type of new document.
              | |
| NewNodeClassName | 
            Class name of the document type of new document.
              | |
| NewNodeCultureCode | 
            Node culture of new document.
              | |
| NextSteps | 
            Next steps
              | |
| Node | 
            Returns currently edited document if it is available in the given context.
              | |
| NodeID | 
            Node ID. Together with DocumentCulture property identifies edited document.
              | |
| ParentNode | 
            Returns parent node for new document insertion.
              | |
| ParentNodeID | 
            Parent node ID. Indicates parent node for document insertion.
              | |
| ProcessingAction | 
            Indicates if workflow action is processed
              | |
| RedirectForNonExistingDocument | 
            Indicates if the UI should be redirected if document not found.
              | |
| RefreshActionContent | 
            Indicates if content should be refreshed (action is being processed)
              | |
| RegisterEvents | 
            Indicates if manager should register for common events (save etc.).
              | |
| RegisterSaveChangesScript | 
            Indicates if the support script for save changes should be registered.
              | |
| RenderScript | 
            Indicates if java script functions for document management should be rendered.
              | |
| SaveChanges | 
            Returns true if the changes should be saved.
              | |
| SetRedirectPageFlag | 
            Indicates whether the page should be redirected to the current page which is being edited.
              | |
| SetRefreshFlag | 
            Indicates whether reload page property should be automatically added to the page for reload page functionality.
              | |
| SiteName | 
            Site name.
              | |
| SourceDocumentID | 
            Document ID of document language version, which should be used as a source data for new culture version
              | |
| SourceNode | 
            Source document for new language version
              | |
| Step | 
            Document workflow step.
              | |
| StopProcessing | 
            Indicates if the control should stop processing
              | |
| Tree | 
            Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
              | |
| UseDocumentHelper | 
            Indicates if DocumentHelper should be used to manage the document (Use FALSE if modifying non-versioned properties.)
              | |
| UseFullFormSaveChanges | 
            Indicates whether changes should be tracked for whole form or just for parts defined by data-tracksavechanges attribute.
              | |
| VersionManager | 
            Version manager instance.
              | |
| Workflow | 
            Document workflow.
              | |
| WorkflowManager | 
            Gets Workflow manager instance.
              | 
Events
| Name | Description | |
|---|---|---|
| OnAfterAction | 
            On after action event handler.
              | |
| OnBeforeAction | 
            On before action event handler.
              | |
| OnCheckConsistency | 
            On check consistency event handler.
              | |
| OnCheckPermissions | 
            On check permissions event handler.
              | |
| OnLoadData | 
            On load data event handler.
              | |
| OnSaveData | 
            On save data event handler.
              | |
| OnSaveFailed | 
            Occurs when saving data fails.
              | |
| OnValidateData | 
            On data validation event handler.
              | 
See Also