Click or drag to resize
HelpAttribute Class
Settings for title of the page.
Inheritance Hierarchy
SystemObject
  SystemAttribute
    CMS.UIControlsAbstractAttribute
      CMS.UIControlsHelpAttribute

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 13.0.131
Syntax
C#
public class HelpAttribute : AbstractAttribute, 
	ICMSFunctionalAttribute, ICMSAttribute

The HelpAttribute type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyContainsMacro
If true, the attribute contains macros
(Inherited from AbstractAttribute.)
Public propertyExistingObject
If True, attribute is applied only when edited object is defined.
(Inherited from AbstractAttribute.)
Public propertyHelpName
Help name to identify the help within the javascript.
Public propertyHelpTopic
Help topic for the title.
Public propertyNewObject
If True, attribute is applied only when edited object is not defined.
(Inherited from AbstractAttribute.)
Top
Methods
  NameDescription
Public methodApply
Applies the attribute data to the page (object).
Protected methodCheckEditedObject
Returns True if attribute should be applied. Evaluation is based on the edited object existence and ExistingObject and NewObject properties.
(Inherited from AbstractAttribute.)
Protected methodGetText
Gets the text for the element.
(Inherited from AbstractAttribute.)
Protected methodGetUrl
Transforms the URL to the correct format.
(Inherited from AbstractAttribute.)
Protected methodResolve
Resolves the give text.
(Inherited from AbstractAttribute.)
Top
See Also