HeaderAction Class

Class for the header action.

Inheritance Hierarchy

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

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

Syntax

public class HeaderAction : NavigationItem

The HeaderAction type exposes the following members.

Constructors

	Name	Description
Public method	HeaderAction	Constructor

Methods

	Name	Description
Public method	IsVisible	Indicates if the action should be visible due to attributes values

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.
Public property	BaseButton	Button to replace.
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
Public property	CommandArgument	Command argument of the action.
Public property	CommandName	Name of the command representing the action.
Public property	CssClass	CSS class of the item. (Inherited from NavigationItem.)
Public property	CultureCode	UI culture code.
Public property	DialogHeight	If action opens dialog, set dialog height
Public property	DialogWidth	If action opens dialog, set dialog width
Public property	Enabled	Indicates if the action is enabled.
Public property	EventName	Name of the event.
Public property	GenerateSeparatorBeforeAction	Indicates whether separator class should be used before current item
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.
Public property	Index	Index of the action.
Public property	IsLiveSite	Indicates if action is used on a live site
Public property	OnClientClick	The JavaScript executed on client click event. (Overrides NavigationItem.OnClientClick.)
Public property	OpenInDialog	If true, the action opens in dialog
Public property	Permission	Permission name to check. For Permission check to work, both Resource name and Permission must be filled.
Public property	RedirectUrl	The URL for redirection. (Inherited from NavigationItem.)
Public property	RegisterShortcutScript	Indicates if save shortcut script should be registered
Public property	ResourceName	Resource name. For Permission check to work, both Resource name and Permission must be filled.
Public property	Target	Target for hyperlink.
Public property	Text	Specifies the the caption of the item. Sample value: "Caption string" (Has higher priority than the resource string.) (Overrides NavigationItem.Text.)
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.
Public property	Visible	Indicates if the action should be visible.