CMSDocumentManager MembersKentico 8.1 API Reference
The CMSDocumentManager type exposes the following members.
Constructors

  NameDescription
Public methodCMSDocumentManager
Constructor.
Back to Top
Methods

  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Protected methodOnlineAddedControl
Called after a child control is added to the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
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 methodOnlineAddParsedSubObject
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's OnlineControlCollection object.
(Inherited from OnlineControl.)
Protected methodAddText
Adds additional text
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodOnlineApplyStyleSheetSkin
Applies the style properties defined in the page style sheet to the control.
(Inherited from OnlineControl.)
Public methodApproveDocument
Approves document.
Public methodArchiveDocument
Archives document
Protected methodOnlineBuildProfileTree
Gathers information about the server control and delivers it to the OnlineTrace property to be displayed when tracing is enabled for the page.
(Inherited from OnlineControl.)
Protected methodOnlineClearCachedClientID
Sets the cached OnlineClientID value to null.
(Inherited from OnlineControl.)
Public methodClearContentChanged
Clears content changed flag
Protected methodOnlineClearEffectiveClientIDMode
Sets the OnlineClientIDMode property of the current control instance and of any child controls to OnlineInherit.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildControlState
Deletes the control-state information for the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildState
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from OnlineControl.)
Protected methodOnlineClearChildViewState
Deletes the view-state information for all the server control's child controls.
(Inherited from OnlineControl.)
Public methodClearNode
Clears current node.
Public methodClearProperties
Clears properties
(Overrides CMSAbstractManager EventArgsType, SimpleEventArgsType  ClearProperties .)
Protected methodOnlineConstruct
Performs design-time logic.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineCreateControlCollection
Creates a new OnlineControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from OnlineControl.)
Protected methodCreateChildControls
CreateChildControls event handler.
(Overrides OnlineControl CreateChildControls .)
Public methodCreateNewVersion
Creates new document version. (Moves document to edit step.)
Protected methodOnlineCreateResourceBasedLiteralControl
Accesses literal strings stored in a resource. The OnlineCreateResourceBasedLiteralControl(Int32, Int32, Boolean) method is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
Public methodOnlineDataBind 
Binds a data source to the invoked server control and all its child controls.
(Inherited from OnlineControl.)
Protected methodOnlineDataBind(Boolean)
Binds a data source to the invoked server control and all its child controls with an option to raise the OnlineDataBinding event.
(Inherited from OnlineControl.)
Protected methodOnlineDataBindChildren
Binds a data source to the server control's child controls.
(Inherited from OnlineControl.)
Public methodOnlineDesignerInitialize
Performs any initialization steps on the user control that are required by RAD designers.
(Inherited from OnlineUserControl.)
Public methodOnlineDispose
Enables a server control to perform final clean up before it is released from memory.
(Inherited from OnlineControl.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEnsureDocumentsConsistency
Ensures documents consistency (Automatic blog post hierarchy etc.)
Protected methodOnlineEnsureChildControls
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from OnlineControl.)
Protected methodOnlineEnsureID
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from OnlineControl.)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
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.)
Protected methodOnlineEval(String, String)
Evaluates a data-binding expression using the specified format string to display the result.
(Inherited from OnlineTemplateControl.)
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 methodEvalDouble
Evaluates the item data and converts it to the integer.
(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.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineFindControl(String)
Searches the current naming container for a server control with the specified id parameter.
(Inherited from OnlineControl.)
Protected methodOnlineFindControl(String, Int32)
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the OnlineFindControl  method.
(Inherited from OnlineControl.)
Public methodOnlineFocus
Sets input focus to a control.
(Inherited from OnlineControl.)
Protected methodOnlineFrameworkInitialize
Initializes the control that is derived from the OnlineTemplateControl class.
(Inherited from OnlineTemplateControl.)
Public methodGetAllowSubmitScript
Gets allow submit script for save changes support
Protected methodGetDefaultCheckPermissionsError
Gets the default error message for check permission error
(Overrides CMSAbstractManager EventArgsType, SimpleEventArgsType  GetDefaultCheckPermissionsError(SimpleEventArgsType).)
Protected methodOnlineGetDesignModeState
Gets design-time data for a control.
(Inherited from OnlineControl.)
Public methodGetDocumentInfo
Gets default document information text
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Protected methodOnlineGetGlobalResourceObject(String, String)
Gets an application-level resource object based on the specified OnlineClassKey and OnlineResourceKey properties.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineGetGlobalResourceObject(String, String, Type, String)
Gets an application-level resource object based on the specified OnlineClassKey and OnlineResourceKey properties, object type, and property name of the resource.
(Inherited from OnlineTemplateControl.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
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
Protected methodOnlineGetLocalResourceObject(String)
Gets a page-level resource object based on the specified OnlineResourceKey property.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineGetLocalResourceObject(String, Type, String)
Gets a page-level resource object based on the specified OnlineResourceKey property, object type, and property name.
(Inherited from OnlineTemplateControl.)
Public methodOnlineGetRouteUrl(Object)
Gets the URL that corresponds to a set of route parameters.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(String, Object)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from OnlineControl.)
Public methodOnlineGetRouteUrl(String, RouteValueDictionary)
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from OnlineControl.)
Public methodGetSaveAndCloseScript
Gets script for save & close action
Public methodGetSaveAnotherScript
Gets script for save another action
Public methodGetString
Returns localized string.
(Inherited from AbstractUserControl.)
Public methodGetSubmitScript
Gets submit script for save changes support
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineGetUniqueIDRelativeTo
Returns the prefixed portion of the OnlineUniqueID property of the specified control.
(Inherited from OnlineControl.)
Public methodOnlineHasControls
Determines if the server control contains any child controls.
(Inherited from OnlineControl.)
Protected methodOnlineHasEvents
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from OnlineControl.)
Public methodHasLocalMessagesPlaceHolder
Indicates if local messages placeholder is used
Protected methodCheckDefaultConsistency
Checks the default consistency for the editing context
(Overrides CMSAbstractManager EventArgsType, SimpleEventArgsType  CheckDefaultConsistency(SimpleEventArgsType).)
Protected methodCheckDefaultSecurity
Checks the default security for the editing context
(Overrides CMSAbstractManager EventArgsType, SimpleEventArgsType  CheckDefaultSecurity(SimpleEventArgsType).)
Public methodCheckInDocument
Checks-in document
Public methodCheckOutDocument
Check-outs document
Public methodOnlineInitializeAsUserControl
Initializes the OnlineUserControl object that has been created declaratively. Since there are some differences between pages and user controls, this method makes sure that the user control is initialized properly.
(Inherited from OnlineUserControl.)
Public methodIsActionAllowed
Checks if given action is allowed
Protected methodOnlineIsLiteralContent
Determines if the server control holds only literal content.
(Inherited from OnlineControl.)
Public methodOnlineLoadControl(String)
Loads a OnlineControl object from a file based on a specified virtual path.
(Inherited from OnlineTemplateControl.)
Public methodOnlineLoadControl(Type,  Object )
Loads a OnlineControl object based on a specified type and constructor parameters.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineLoadControlState
Restores control-state information from a previous page request that was saved by the OnlineSaveControlState  method.
(Inherited from OnlineControl.)
Public methodOnlineLoadTemplate
Obtains an instance of the OnlineITemplate interface from an external file.
(Inherited from OnlineTemplateControl.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Protected methodOnlineLoadViewState
Restores the view-state information from a previous user control request that was saved by the OnlineSaveViewState  method.
(Inherited from OnlineUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnlineMapPath
Assigns a virtual file path, either absolute or relative, to a physical file path.
(Inherited from OnlineUserControl.)
Protected methodOnlineMapPathSecure
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from OnlineControl.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineOnAbortTransaction
Raises the OnlineAbortTransaction event.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineOnBubbleEvent
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from OnlineControl.)
Protected methodOnlineOnCommitTransaction
Raises the OnlineCommitTransaction event.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineOnDataBinding
Raises the OnlineDataBinding event.
(Inherited from OnlineControl.)
Protected methodOnlineOnError
Raises the OnlineError event.
(Inherited from OnlineTemplateControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
Load event
(Overrides AbstractUserControl OnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Overrides AbstractUserControl OnPreRender(EventArgs).)
Protected methodOnlineOnUnload
Raises the OnlineUnload event.
(Inherited from OnlineControl.)
Protected methodOnlineOpenFile
Gets a OnlineStream used to read a file.
(Inherited from OnlineControl.)
Public methodOnlineParseControl(String)
Parses an input string into a OnlineControl object on the Web Forms page or user control.
(Inherited from OnlineTemplateControl.)
Public methodOnlineParseControl(String, Boolean)
Parses an input string into a OnlineControl object on the ASP.NET Web page or user control.
(Inherited from OnlineTemplateControl.)
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 CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Protected methodRaiseBeforeAction
Raises event before action
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Protected methodOnlineRaiseBubbleEvent
Assigns any sources of the event and its information to the control's parent.
(Inherited from OnlineControl.)
Protected methodRaiseCheckConsistency
Raises event to check consistency
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Protected methodRaiseCheckPermissions
Raises event to check permissions
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Protected methodRaiseLoadData
Raises event to load data
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public methodRaisePostBackEvent
Raises the post back event.
Protected methodRaiseSaveData
Raises event to get data to save
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Protected methodRaiseSaveFailed
Raises event when saving data fails
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Protected methodRaiseValidateData
Raises event to validate data
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public methodOnlineReadStringResource
Reads a string resource. The OnlineReadStringResource  method is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
Public methodRegisterRefreshScript
Sets the reload page attributes
Public methodRejectDocument(String)
Rejects document
Public methodRejectDocument(Int32, String)
Rejects document
Protected methodOnlineRemovedControl
Called after a child control is removed from the OnlineControls collection of the OnlineControl object.
(Inherited from OnlineControl.)
Public methodRemoveWireframe
Removes the wireframe from current document
Protected methodRender
Render action.
(Overrides AbstractUserControl Render(HtmlTextWriter).)
Public methodOnlineRenderControl(HtmlTextWriter)
Outputs server control content to a provided OnlineHtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from OnlineControl.)
Protected methodOnlineRenderControl(HtmlTextWriter, ControlAdapter)
Outputs server control content to a provided OnlineHtmlTextWriter object using a provided OnlineControlAdapter object.
(Inherited from OnlineControl.)
Protected methodOnlineRenderChildren
Outputs the content of a server control's children to a provided OnlineHtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from OnlineControl.)
Public methodRenderScripts
Renders scripts
Protected methodOnlineResolveAdapter
Gets the control adapter responsible for rendering the specified control.
(Inherited from OnlineControl.)
Public methodOnlineResolveClientUrl
Gets a URL that can be used by the browser.
(Inherited from OnlineControl.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Protected methodOnlineSaveControlState
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from OnlineControl.)
Public methodSaveDocument
Saves document.
Protected methodSaveDocumentInternal
Saves document.
Protected methodOnlineSaveViewState
Saves any user control view-state changes that have occurred since the last page postback.
(Inherited from OnlineUserControl.)
Protected methodOnlineSetDesignModeState
Sets design-time data for a control.
(Inherited from OnlineControl.)
Public methodOnlineSetRenderMethodDelegate
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from OnlineControl.)
Protected methodOnlineSetStringResourcePointer
Sets a pointer to a string resource. The OnlineSetStringResourcePointer(Object, Int32) method is used by generated classes and is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
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 methodShowChangesSaved
Shows the general changes saved message.
(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 methodOnlineTestDeviceFilter
Returns a Boolean value indicating whether a device filter applies to the HTTP request.
(Inherited from OnlineTemplateControl.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Protected methodOnlineTrackViewState
Causes tracking of view-state changes to the server control so they can be stored in the server control's OnlineStateBag object. This object is accessible through the OnlineViewState property.
(Inherited from OnlineControl.)
Public methodUndoCheckOutDocument
Undoes check-out document
Public methodUpdateDocument
Updates the current document
Protected methodUpdateDocumentInternal
Updates the current document
Protected methodOnlineWriteUTF8ResourceString
Writes a resource string to an OnlineHtmlTextWriter control. The OnlineWriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) method is used by generated classes and is not intended for use from within your code.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String)
Evaluates an XPath data-binding expression.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String, String)
Evaluates an XPath data-binding expression using the specified format string to display the result.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPath(String, String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and the specified format string to display the result.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPathSelect(String)
Evaluates an XPath data-binding expression and returns a node collection that implements the OnlineIEnumerable interface.
(Inherited from OnlineTemplateControl.)
Protected methodOnlineXPathSelect(String, IXmlNamespaceResolver)
Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and returns a node collection that implements the OnlineIEnumerable interface.
(Inherited from OnlineTemplateControl.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to 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
Back to Top
Properties

  NameDescription
Public propertyActionComment
Action comment
Protected propertyOnlineAdapter
Gets the browser-specific adapter for the control.
(Inherited from OnlineControl.)
Public propertyAllowSave
Indicates if Save action is allowed.
Public propertyOnlineApplication
Gets the OnlineApplication object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyOnlineAppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the OnlinePage or OnlineUserControl object that contains this control.
(Inherited from OnlineControl.)
Public propertyOnlineAppRelativeVirtualPath
Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled.
(Inherited from OnlineTemplateControl.)
Public propertyOnlineAttributes
Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file.
(Inherited from OnlineUserControl.)
Protected propertyOnlineAutoHandlersObsolete.
The OnlineAutoHandlers property has been deprecated in ASP.NET NET 2.0. It is used by generated classes and is not intended for use within your code.
(Inherited from OnlineTemplateControl.)
Public propertyAutoCheck
Indicates if check-in/check-out functionality is automatic.
Public propertyOnlineBindingContainer
Gets the control that contains this control's data binding.
(Inherited from OnlineControl.)
Public propertyOnlineCache
Gets the OnlineCache object that is associated with the application that contains the user control.
(Inherited from OnlineUserControl.)
Public propertyOnlineCachePolicy
Gets a reference to a collection of caching parameters for this user control.
(Inherited from OnlineUserControl.)
Public propertyOnlineClientID
Gets the control ID for HTML markup that is generated by ASP.NET.
(Inherited from OnlineControl.)
Public propertyOnlineClientIDMode
Gets or sets the algorithm that is used to generate the value of the OnlineClientID property.
(Inherited from OnlineControl.)
Protected propertyOnlineClientIDSeparator
Gets a character value representing the separator character used in the OnlineClientID property.
(Inherited from OnlineControl.)
Public propertyCloseDialog
Indicates whether dialog should be closed after action
Public propertyComponentName
Component name
(Overrides AbstractUserControl ComponentName.)
Public propertyConfirmChanges
Indicates if confirm dialog should be displayed if any change to the document was made
Protected propertyOnlineContext
Gets the OnlineHttpContext object associated with the server control for the current Web request.
(Inherited from OnlineControl.)
Public propertyOnlineControls
Gets a OnlineControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from OnlineControl.)
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 CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public propertyOnlineDataItemContainer
Gets a reference to the naming container if the naming container implements OnlineIDataItemContainer.
(Inherited from OnlineControl.)
Public propertyOnlineDataKeysContainer
Gets a reference to the naming container if the naming container implements OnlineIDataKeysControl.
(Inherited from OnlineControl.)
Protected propertyOnlineDesignMode
Gets a value indicating whether a control is being used on a design surface.
(Inherited from OnlineControl.)
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 propertyEditedObject
Control's edited object
(Inherited from AbstractUserControl.)
Public propertyOnlineEnableTheming
Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the OnlineTemplateControl class.
(Inherited from OnlineTemplateControl.)
Public propertyOnlineEnableViewState
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from OnlineControl.)
Protected propertyOnlineEvents
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from OnlineControl.)
Public propertyGroupID
Community group ID
Public propertyHandleWorkflow
Indicates if workflow actions should be displayed and handled
Protected propertyOnlineHasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from OnlineControl.)
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 CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Protected propertyOnlineChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from OnlineControl.)
Public propertyOnlineID
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from OnlineControl.)
Protected propertyOnlineIdSeparator
Gets the character used to separate control identifiers.
(Inherited from OnlineControl.)
Public propertyInvariantNode
Returns current document in any culture.
Protected propertyOnlineIsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from OnlineControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyOnlineIsPostBack
Gets a value indicating whether the user control is being loaded in response to a client postback, or if it is being loaded and accessed for the first time.
(Inherited from OnlineUserControl.)
Protected propertyOnlineIsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from OnlineControl.)
Protected propertyOnlineIsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from OnlineControl.)
Public propertyLoadDefaultValues
Indicates if default values should be loaded when new document or language version is being created.
Protected propertyOnlineLoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by OnlineID instead of index.
(Inherited from OnlineControl.)
Public propertyLocalDocumentPanel
Local document info panel
Public propertyLocalMessagesPlaceHolder
Local messages placeholder
Public propertyMessagesPlaceHolder
Messages placeholder
(Overrides AbstractUserControl MessagesPlaceHolder.)
Public propertyMode
Manager mode (Update, Insert, New culture version)
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public propertyOnlineNamingContainer
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same OnlineID property value.
(Inherited from OnlineControl.)
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 propertyOnlinePage
Gets a reference to the OnlinePage instance that contains the server control.
(Inherited from OnlineControl.)
Public propertyOnlineParent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from OnlineControl.)
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 propertyOnlineRenderingCompatibility
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from OnlineControl.)
Public propertyRenderScript
Indicates if java script functions for document management should be rendered.
Public propertyOnlineRequest
Gets the OnlineHttpRequest object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyResourceCulture
Resource strings culture
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public propertyOnlineResponse
Gets the OnlineHttpResponse object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertySaveChanges
Returns true if the changes should be saved.
Public propertyOnlineServer
Gets the OnlineHttpServerUtility object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyOnlineSession
Gets the OnlineHttpSessionState object for the current Web request.
(Inherited from OnlineUserControl.)
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.)
Public propertyOnlineSite
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from OnlineControl.)
Protected propertySiteID
Gets site ID of the newly created document.
Public propertySiteName
Site name of the newly created document.
Public propertyOnlineSkinID
Gets or sets the skin to apply to the control.
(Inherited from OnlineControl.)
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.)
Protected propertyOnlineSupportAutoEvents
Gets a value indicating whether the OnlineTemplateControl control supports automatic events.
(Inherited from OnlineTemplateControl.)
Public propertyOnlineTemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from OnlineControl.)
Public propertyOnlineTemplateSourceDirectory
Gets the virtual directory of the OnlinePage or OnlineUserControl that contains the current server control.
(Inherited from OnlineControl.)
Public propertyOnlineTrace
Gets the OnlineTraceContext object for the current Web request.
(Inherited from OnlineUserControl.)
Public propertyTree
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
Public propertyOnlineUniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from OnlineControl.)
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.
Protected propertyOnlineViewState
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from OnlineControl.)
Protected propertyOnlineViewStateIgnoresCase
Gets a value that indicates whether the OnlineStateBag object is case-insensitive.
(Inherited from OnlineControl.)
Public propertyOnlineViewStateMode
Gets or sets the view-state mode of this control.
(Inherited from OnlineControl.)
Public propertyOnlineVisible
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from OnlineControl.)
Public propertyWorkflow
Document workflow.
Public propertyWorkflowManager
Gets Workflow manager instance.
Back to Top
Events

  NameDescription
Public eventOnlineAbortTransaction
Occurs when a user ends a transaction.
(Inherited from OnlineTemplateControl.)
Public eventOnlineCommitTransaction
Occurs when a transaction completes.
(Inherited from OnlineTemplateControl.)
Public eventOnlineDataBinding
Occurs when the server control binds to a data source.
(Inherited from OnlineControl.)
Public eventOnlineDisposed
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from OnlineControl.)
Public eventOnlineError
Occurs when an unhandled exception is thrown.
(Inherited from OnlineTemplateControl.)
Public eventOnlineInit
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from OnlineControl.)
Public eventOnlineLoad
Occurs when the server control is loaded into the OnlinePage object.
(Inherited from OnlineControl.)
Public eventOnAfterAction
On after action event handler.
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public eventOnBeforeAction
On before action event handler.
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public eventOnCheckConsistency
On check consistency event handler.
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public eventOnCheckPermissions
On check permissions event handler.
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public eventOnLoadData
On load data event handler.
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public eventOnSaveData
On save data event handler.
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public eventOnSaveFailed
Occurs when saving data fails.
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public eventOnValidateData
On data validation event handler.
(Inherited from CMSAbstractManager EventArgsType, SimpleEventArgsType .)
Public eventOnlinePreRender
Occurs after the OnlineControl object is loaded but prior to rendering.
(Inherited from OnlineControl.)
Public eventOnlineUnload
Occurs when the server control is unloaded from memory.
(Inherited from OnlineControl.)
Back to Top
See Also