Click or drag to resize
CMSDocumentManager Properties

The CMSDocumentManager type exposes the following members.

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 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 propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
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 propertyGroupID
Community group ID
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 propertyCheckPermissions
Indicates if document permissions should be checked.
(Inherited from CMSAbstractManagerEventArgsType, SimpleEventArgsType.)
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
See Also