HelpAttribute Class

Settings for title of the page.

Inheritance Hierarchy

System.Object
  System.Attribute
    CMS.UIControls.AbstractAttribute
      CMS.UIControls.HelpAttribute

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

Syntax

public class HelpAttribute : AbstractAttribute, 
	ICMSFunctionalAttribute, ICMSAttribute

The HelpAttribute type exposes the following members.

Constructors

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

Properties

	Name	Description
Public property	ContainsMacro	If true, the attribute contains macros (Inherited from AbstractAttribute.)
Public property	ExistingObject	If True, attribute is applied only when edited object is defined. (Inherited from AbstractAttribute.)
Public property	HelpName	Help name to identify the help within the javascript.
Public property	HelpTopic	Help topic for the title.
Public property	NewObject	If True, attribute is applied only when edited object is not defined. (Inherited from AbstractAttribute.)

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.)
Protected method	Resolve	Resolves the give text. (Inherited from AbstractAttribute.)