The Action type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
Action |
Constructor.
| |
Action(String) |
Constructor
| |
Action(XmlNode) |
Constructor.
|
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods
Name | Description | |
---|---|---|
AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) | |
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Properties
Name | Description | |
---|---|---|
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$"
| |
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.
| |
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$"
| |
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.ExtendedControls.CMSContextMenuControl class.
Sample value: "~/CMSAdminControls/UI/UniGrid/Controls/ObjectMenu.ascx"
| |
ExternalSourceName |
Name of the action that is passed as the sourceName parameter of the OnExternalDataBound event handler.
Sample value: "deletefile"
| |
FontIconClass |
Gets or sets the CSS class that serves as icon for the button.
| |
FontIconStyle |
Gets or sets the style of the font icon.
| |
HideIfNotAuthorized |
Indicates if action is hidden if user is not authorized for specified module permissions and module UI elements.
| |
Icon |
Name of the image that should be used as the icon of the action. The image must be located in the folder defined by the ImageDirectoryPath property of the UniGrid.
Sample value: "delete.png"
| |
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}')"
| |
ModuleName |
Module code name
Sample value: "cms.ecommerce"
| |
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"
| |
Name |
Name of the action. This is passed to the handler of the OnAction event as the actionName parameter.
Sample value: "delete"
| |
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}’);"
| |
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"
| |
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"
|
See Also