DocumentListMassActionsParameters Class

Properties which are needed to perform mass action on the DocumentList. This mainly includes filter values (so correct where condition can be produced), URLs of the opened dialogs, etc.

Inheritance Hierarchy

System.Object
  CMS.Controls.DocumentListMassActionsParameters

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 8.2.23

Syntax

public class DocumentListMassActionsParameters

The DocumentListMassActionsParameters type exposes the following members.

Constructors

	Name	Description
Public method	DocumentListMassActionsParameters

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	ArchiveReturnUrl	Return URL for archive action.
Public property	ClassID	ID of the document type which child nodes are to be displayed. 0 if all document types are displayed.
Public property	CurrentWhereCondition	Where condition of the filter.
Public property	DeleteReturnUrl	Return URL for delete action.
Public property	GetCopyMoveLinkBaseActionUrl	Function which creates path where content tree in copy/move/link dialogs will start. The only parameter is name of the action ("Move", "Copy" or "Link").
Public property	Identifier	Random identifier which can be used as a key when storing dialog parameters to the WindowHelper.
Public property	Node	Node whose children are displayed.
Public property	PublishReturnUrl	Return URL for publish action.
Public property	RequiresDialog	Indicates whether the page is displayed as dialog.
Public property	ShowAllLevels	True if all levels of documents are displayed. False if only one nested level is displayed.
Public property	TranslateReturnUrl	Return URL for translate action.
Public property	WOpenerNodeID	WOpenerNodeID from the url query.