DeleteDocument Properties Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

The DeleteDocument type exposes the following members.

Properties

  Name Description
Public property BackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public property ClassName
Sets or gets a value that specifies a CSS class name to be applied to the generated link or button element. The default value is an empty string
Public property ComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public property ConfirmText
Sets or gets a confirmation message to be displayed to the caller prior to the actual delete. The default value is "Are you sure you want to delete the document?"
Public property Conformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Protected property Code example CS_DataFields
Gets a EPTXmlParser that contains a collection of EPT field definitions and values. This property is the replacement for the obsolete EPT_GetFieldName(String) and EPT_GetFieldValue(String) methods.
(Inherited from CodeBase.)
Public property DeleteParentChildRelation
Sets or gets a value that indicates whether it is allowed to delete a document that has child documents or not. When this property is set the relation is broken between the document and its children thus breaking off the document hierarchy at this point. This property is ignored unless the DeletePermanently property is set also. The default value is false.
Public property DeletePermanently
Sets or gets a value that indicates if the document should be deleted permanently rather that being thrown in the recycling bin. This will not work unless the caller has administrative permissions on the document or has the DestroyDocuments global right set. The default value is false.
Public property DeleteRoot
Sets or gets a value that specifies whether to delete the root document or not. This value has no meaning unless the document to delete is an include document. The default value is false
Public property DoAccessCheck
Sets or gets a value the defines whether the component should do an access check to determine if the user has access to delete or not. If the access check, the component will not display a delete button. The default value is true.
Public property DocToDelete
Sets or gets a document to delete. If this property is zero the current document is deleted. The default value is an empty string
Public property ElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public property Encoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public property Label
Sets or gets the text for the generated button or link. The default value is "Delete"
Public property LinkType
Sets or gets a value that specifies what type of HTML element to generate The default value is Link
Protected property Page
A reference to the current context page. This will initialize in the constructor of this class.
(Inherited from CodeBase.)
Public property RedirectDocument
Sets or gets a value that specifies a document to redirect to after that the document has been deleted. The default value is an empty string
Public property RedirectPresentationTemplate
Sets or gets an optional presentation template to be used present the document indicated in the RedirectDocument property. The default value is an empty string
Protected property RunningUserControl
Gets the current running user control.
(Inherited from CodeBase.)
Top
See Also

Reference