SecurityAttribute Class

Checks specified permissions and UI elements for given resource and performs redirect if checks fails. Works only with pages inherited from CMSPage class.

Inheritance Hierarchy

System.Object
  System.Attribute
    CMS.UIControls.AbstractAttribute
      CMS.UIControls.AbstractSecurityAttribute
        CMS.UIControls.SecurityAttribute

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

Syntax

public class SecurityAttribute : AbstractSecurityAttribute, 
	ICMSSecurityAttribute, ICMSAttribute

The SecurityAttribute type exposes the following members.

Constructors

	Name	Description
Public method	SecurityAttribute()	Constructor.
Public method	SecurityAttribute(String)	Constructor.
Public method	SecurityAttribute(String, String, String)	Constructor.

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	GlobalAdministrator	If true, the global admin check should be performed. (Inherited from AbstractSecurityAttribute.)
Public property	IsAllowed	If true, the security check is allowed, if false, it automatically returns false. (Inherited from AbstractSecurityAttribute.)
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	UIElements	UI elements to be checked separated by semicolon ;. (Inherited from AbstractSecurityAttribute.)

Methods

	Name	Description
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.)
Public method	Check	Does the security check and performs redirect if user has insufficient permissions.
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	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.)
Protected method	Resolve	Resolves the give text. (Inherited from AbstractAttribute.)