UIElementAttribute Class

Initializes page with license and security checks. Performs redirect if security check fails. Works only with pages inherited from CMSPage class.

Inheritance Hierarchy

System.Object
  System.Attribute
    CMS.UIControls.AbstractAttribute
      CMS.UIControls.UIElementAttribute

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

Syntax

public class UIElementAttribute : AbstractAttribute, 
	ICMSSecurityAttribute, ICMSAttribute

The UIElementAttribute type exposes the following members.

Constructors

	Name	Description
Public method	UIElementAttribute(String, String)	Constructor.
Public method	UIElementAttribute(String, String, Boolean, Boolean)	Constructor.

Properties

	Name	Description
Public property	CheckPermissions	Indicates whether permission should be checked (incl. UI personalization, Permissions, Resource on site)
Public property	ContainsMacro	If true, the attribute contains macros (Inherited from AbstractAttribute.)
Public property	ElementName	UI Element name
Public property	ExistingObject	If True, attribute is applied only when edited object is defined. (Inherited from AbstractAttribute.)
Public property	NewObject	If True, attribute is applied only when edited object is not defined. (Inherited from AbstractAttribute.)
Public property	ResourceName	Resource name
Public property	ValidateDialogHash	Indicates whether hash for dialogs should be validated (use only for legacy pages)

Methods

	Name	Description
Public method	Check	Initializes page with license and security checks. Performs redirect if security check fails.
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.)
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	Resolve	Resolves the give text. (Inherited from AbstractAttribute.)