ActionAttribute Class

Adds action to the page.

Inheritance Hierarchy

System.Object
  System.Attribute
    CMS.UIControls.AbstractAttribute
      CMS.UIControls.AbstractSecurityAttribute
        CMS.UIControls.AbstractElementAttribute
          CMS.UIControls.ActionAttribute
            CMS.UIControls.SaveActionAttribute

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23

Syntax

public class ActionAttribute : AbstractElementAttribute, 
	ICMSFunctionalAttribute, ICMSAttribute

The ActionAttribute type exposes the following members.

Constructors

	Name	Description
Public method	ActionAttribute(Int32)	Constructor.
Public method	ActionAttribute(Int32, String, String)	Constructor.
Public method	ActionAttribute(Int32, String, String, String, String)	Constructor.

Methods

	Name	Description
Public method	Apply	Applies the attribute data to the page (object).
Protected method	GetText	Gets the text for the element. (Inherited from AbstractAttribute.)
Protected method	GetUrl	Transforms the URL to the correct format. (Inherited from AbstractAttribute.)
Protected method	CheckEditedObject	Returns True if attribute should be applied. Evaluation is based on the edited object existence and ExistingObject and NewObject properties. (Inherited from AbstractAttribute.)
Public method	CheckEditor	Checks the security of the editor, returns true if the security check succeeded. (Inherited from AbstractSecurityAttribute.)
Public method	CheckGlobalAdministrator	Checks the security of the global admin, returns true if the security check succeeded. (Inherited from AbstractSecurityAttribute.)
Public method	CheckLicense	Checks the license, returns true if the license is valid against current domain. (Inherited from AbstractElementAttribute.)
Public method	CheckModuleLoaded	Checks if resource is loaded, returns false if resource/module is separated. (Inherited from AbstractSecurityAttribute.)
Public method	CheckPermissions	Checks the security of the permissions, returns true if the security check succeeded. (Inherited from AbstractSecurityAttribute.)
Public method	CheckResourceSite	Checks the security of resource, returns true if the module is assigned to the current site. (Inherited from AbstractSecurityAttribute.)
Public method	CheckSecurity	Checks the security, returns true if the security check succeeded. (Inherited from AbstractSecurityAttribute.)
Public method	CheckUIElements	Checks the security of the UI elements, returns true if the security check succeeded. (Inherited from AbstractSecurityAttribute.)
Public method	CheckVisibility	Checks if the element is visible. Returns true if it is allowed to be shown. (Inherited from AbstractElementAttribute.)
Protected method	Resolve	Resolves the give text. (Inherited from AbstractAttribute.)

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	ContainsMacro	If true, the attribute contains macros (Inherited from AbstractAttribute.)
Protected property	CurrentSiteName	Current site name. (Inherited from AbstractSecurityAttribute.)
Protected property	CurrentUser	Current user. (Inherited from AbstractSecurityAttribute.)
Public property	Editor	If true, the editor should be checked. (Inherited from AbstractSecurityAttribute.)
Public property	ExistingObject	If True, attribute is applied only when edited object is defined. (Inherited from AbstractAttribute.)
Public property	Feature	Feature to check. (Inherited from AbstractElementAttribute.)
Public property	GlobalAdministrator	If true, the global admin check should be performed. (Inherited from AbstractSecurityAttribute.)
Public property	Index	Index of the action.
Public property	IsAllowed	If true, the security check is allowed, if false, it automatically returns false. (Inherited from AbstractSecurityAttribute.)
Public property	Javascript	Javascript to execute on click.
Public property	NewObject	If True, attribute is applied only when edited object is not defined. (Inherited from AbstractAttribute.)
Public property	Permission	Permission name to be checked. (Inherited from AbstractSecurityAttribute.)
Public property	Resource	Resource name to be checked. (Inherited from AbstractSecurityAttribute.)
Public property	ResourceSite	If true, the resource assignment to the site should be checked. (Inherited from AbstractSecurityAttribute.)
Public property	ResourceString	Resource string for the text.
Public property	TargetUrl	Target URL for the breadcrumb item.
Public property	Text	Text of the breadcrumbs, has higher priority than the resource string.
Public property	TooltipResourceString	Tooltip resource string.
Public property	TooltipText	Tooltip text, has higher priority than the tooltip resource string.
Public property	UIElements	UI elements to be checked separated by semicolon ;. (Inherited from AbstractSecurityAttribute.)