Click or drag to resize
HeaderAction Class
Class for the header action.
Inheritance Hierarchy
SystemObject
  CMS.ExtendedControlsNavigationItem
    CMS.ExtendedControls.ActionsConfigHeaderAction
      More...

Namespace: CMS.ExtendedControls.ActionsConfig
Assembly: CMS.ExtendedControls (in CMS.ExtendedControls.dll) Version: 8.2.23
Syntax
C#
public class HeaderAction : NavigationItem

The HeaderAction type exposes the following members.

Constructors
  NameDescription
Public methodHeaderAction
Constructor
Top
Methods
  NameDescription
Public methodIsVisible
Indicates if the action should be visible due to attributes values
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 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.)
Top
Properties
  NameDescription
Public propertyAlternativeActions
Alternative actions to be displayed in context menu.
Public propertyBaseButton
Button to replace.
Public propertyButtonStyle
Style of the header action button. Only applicable when action has no alternative actions. Multibutton (button displaying alternative actions) is always default
Public propertyCommandArgument
Command argument of the action.
Public propertyCommandName
Name of the command representing the action.
Public propertyCssClass
CSS class of the item.
(Inherited from NavigationItem.)
Public propertyCultureCode
UI culture code.
Public propertyDialogHeight
If action opens dialog, set dialog height
Public propertyDialogWidth
If action opens dialog, set dialog width
Public propertyEnabled
Indicates if the action is enabled.
Public propertyEventName
Name of the event.
Public propertyGenerateSeparatorBeforeAction
Indicates whether separator class should be used before current item
Public propertyInactive
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 propertyIndex
Index of the action.
Public propertyIsLiveSite
Indicates if action is used on a live site
Public propertyOnClientClick
The JavaScript executed on client click event.
(Overrides NavigationItemOnClientClick.)
Public propertyOpenInDialog
If true, the action opens in dialog
Public propertyPermission
Permission name to check. For Permission check to work, both Resource name and Permission must be filled.
Public propertyRedirectUrl
The URL for redirection.
(Inherited from NavigationItem.)
Public propertyRegisterShortcutScript
Indicates if save shortcut script should be registered
Public propertyResourceName
Resource name. For Permission check to work, both Resource name and Permission must be filled.
Public propertyTarget
Target for hyperlink.
Public propertyText
Specifies the the caption of the item. Sample value: "Caption string" (Has higher priority than the resource string.)
(Overrides NavigationItemText.)
Public propertyTooltip
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 propertyValidationGroup
Validation group name.
Public propertyVisible
Indicates if the action should be visible.
Top
See Also
Inheritance Hierarchy
SystemObject
  CMS.ExtendedControlsNavigationItem
    CMS.ExtendedControls.ActionsConfigHeaderAction
      CMS.ExtendedControls.ActionsConfigCommentAction
      CMS.ExtendedControls.ActionsConfigCustomizeAction
      CMS.ExtendedControls.ActionsConfigDeleteAction
      CMS.ExtendedControls.ActionsConfigDocumentApproveAction
      CMS.ExtendedControls.ActionsConfigDocumentArchiveAction
      CMS.ExtendedControls.ActionsConfigDocumentCheckInAction
      CMS.ExtendedControls.ActionsConfigDocumentCheckOutAction
      CMS.ExtendedControls.ActionsConfigDocumentPublishAction
      CMS.ExtendedControls.ActionsConfigDocumentRejectAction
      CMS.ExtendedControls.ActionsConfigDocumentUndoCheckOutAction
      CMS.ExtendedControls.ActionsConfigNextStepAction
      CMS.ExtendedControls.ActionsConfigPreviousStepAction
      CMS.ExtendedControls.ActionsConfigSaveAction