AbstractAction Class

Base class for the UniGrid actions.

Inheritance Hierarchy

System.Object
  CMS.UIControls.UniGridConfig.AbstractAction
    CMS.UIControls.UniGridConfig.Action
    CMS.UIControls.UniGridConfig.ButtonAction
    CMS.UIControls.UniGridConfig.EmptyAction

Namespace: CMS.UIControls.UniGridConfig
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 12.0.0

Syntax

public abstract class AbstractAction

The AbstractAction type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractAction()	Initalizes a new instance of AbstractAction.
Protected method	AbstractAction(String)	Initalizes a new instance of AbstractAction with given name.
Protected method	AbstractAction(XElement)	Initalizes a new instance of AbstractAction with given action.

Properties

	Name	Description
Public property	Caption	Specifies the resource string used as the tooltip of the image defined in the icon attribute. Must begin and end with the $ character. Sample value: "$General.Delete$"
Public property	CaptionText	Gets the caption text of the action. Caches the value.
Public property	CommandArgument	The name of the column whose value should be passed as the actionArgument parameter of the OnAction event handler. If not defined, the first column of the data source is used.
Public property	Confirmation	The resource string used in a JavaScript confirmation. Most commonly used as a confirmation for delete type actions. Must begin and end with the $ character. Sample value: "$General.ConfirmDelete$"
Public property	ContextMenu	The relative path to a control (.ascx file) that implements a context menu for the action. Controls created for this purpose must inherit from the CMS.Base.Web.UI.CMSContextMenuControl class. Sample value: "~/CMSAdminControls/UI/UniGrid/Controls/ObjectMenu.ascx"
Public property	ExternalSourceName	Name of the action that is passed as the sourceName parameter of the OnExternalDataBound event handler. Sample value: "deletefile"
Public property	HideIfNotAuthorized	Indicates if action is hidden if user is not authorized for specified module permissions and module UI elements.
Public property	MenuParameter	Contains an array of parameters passed to the control implementing the action's context menu (the path to this control must be specified in the contextmenu attribute). These parameters may be retrieved in the control's code using the GetContextMenuParameter JavaScript function. The columns defined in the parameters attribute of the <actions> element may be entered as parameters using the following expressions: {0} - first parameter {1} - second parameter and so forth. "new Array('cms.site', '{0}')"
Public property	ModuleName	Module code name. Sample value: "cms.ecommerce"
Public property	MouseButton	Specifies which mouse button causes the action's context menu to appear (if a context menu is enabled via the contextmenu attribute). If not defined, both mouse buttons open the context menu. Possible values: "left", "right"
Public property	Name	Name of the action. This is passed to the handler of the OnAction event as the actionName parameter. Sample value: "delete"
Public property	OnClick	The JavaScript OnClick function for the given action. It may use the columns defined in the parameters attribute of the 'actions' element as parameters, which can be called by using the following expressions: {0} - first parameter {1} - second parameter and so forth. "alert(‘{0}’);"
Public property	Permissions	Names of the module permissions which should be checked before the action is handled. Use comma as separator for multiple permissions. Sample value: "modify;manage"
Public property	SafeName	Safe name of the action which can be used as an identifier. Caches the value.
Public property	UIElements	Names of the module UI elements which should be checked before the action is handled. Use comma as separator for multiple UI elements. Sample value: "uielement1;uielement2"

Methods

	Name	Description
Protected method Static member	GetAttribute(XmlNode, String)	Gets the value for particular attribute of the XML node.
Protected method Static member	GetAttribute(XmlNode, String, String)	Gets the value for particular attribute of the XML node.