DocumentArchiveAction Class

Class for the document archive action.

Inheritance Hierarchy

System.Object
  CMS.ExtendedControls.NavigationItem
    CMS.ExtendedControls.ActionsConfig.HeaderAction
      CMS.ExtendedControls.ActionsConfig.DocumentArchiveAction

Namespace: CMS.ExtendedControls.ActionsConfig
Assembly: CMS.ExtendedControls (in CMS.ExtendedControls.dll) Version: 8.2.23

Syntax

public class DocumentArchiveAction : HeaderAction

The DocumentArchiveAction type exposes the following members.

Constructors

	Name	Description
Public method	DocumentArchiveAction	Constructor

Methods

	Name	Description
Public method	IsVisible	Indicates if the action should be visible due to attributes values (Inherited from HeaderAction.)

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	AlternativeActions	Alternative actions to be displayed in context menu. (Inherited from HeaderAction.)
Public property	BaseButton	Button to replace. (Inherited from HeaderAction.)
Public property	ButtonStyle	Style of the header action button. Only applicable when action has no alternative actions. Multibutton (button displaying alternative actions) is always default (Inherited from HeaderAction.)
Public property	CommandArgument	Command argument of the action. (Inherited from HeaderAction.)
Public property	CommandName	Name of the command representing the action. (Inherited from HeaderAction.)
Public property	CssClass	CSS class of the item. (Inherited from NavigationItem.)
Public property	CultureCode	UI culture code. (Inherited from HeaderAction.)
Public property	DialogHeight	If action opens dialog, set dialog height (Inherited from HeaderAction.)
Public property	DialogWidth	If action opens dialog, set dialog width (Inherited from HeaderAction.)
Public property	Enabled	Indicates if the action is enabled. (Inherited from HeaderAction.)
Public property	EventName	Name of the event. (Inherited from HeaderAction.)
Public property	GenerateSeparatorBeforeAction	Indicates whether separator class should be used before current item (Inherited from HeaderAction.)
Public property	Inactive	Indicates if the action is inactive. Only applicable when action has alternative action. When inactive action can't be executed. Clicking on the action is used to toogle the visibility of alternative actions. (Inherited from HeaderAction.)
Public property	Index	Index of the action. (Inherited from HeaderAction.)
Public property	IsLiveSite	Indicates if action is used on a live site (Inherited from HeaderAction.)
Public property	OnClientClick	The JavaScript executed on client click event. (Inherited from HeaderAction.)
Public property	OpenInDialog	If true, the action opens in dialog (Inherited from HeaderAction.)
Public property	Permission	Permission name to check. For Permission check to work, both Resource name and Permission must be filled. (Inherited from HeaderAction.)
Public property	RedirectUrl	The URL for redirection. (Inherited from NavigationItem.)
Public property	RegisterShortcutScript	Indicates if save shortcut script should be registered (Inherited from HeaderAction.)
Public property	ResourceName	Resource name. For Permission check to work, both Resource name and Permission must be filled. (Inherited from HeaderAction.)
Public property	Target	Target for hyperlink. (Inherited from HeaderAction.)
Public property	Text	Specifies the the caption of the item. Sample value: "Caption string" (Has higher priority than the resource string.) (Inherited from HeaderAction.)
Public property	Tooltip	Specifies the the tooltip of the item (string.empty: empty, null: usually copies caption or custom string). (Has higher priority than the tooltip resource string.) (Inherited from NavigationItem.)
Public property	ValidationGroup	Validation group name. (Inherited from HeaderAction.)
Public property	Visible	Indicates if the action should be visible. (Inherited from HeaderAction.)