DocumentationHelper Class

Helper methods for documentation links.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<DocumentationHelper>
        CMS.Helpers.DocumentationHelper

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

Syntax

public class DocumentationHelper : AbstractHelper<DocumentationHelper>

The DocumentationHelper type exposes the following members.

Constructors

	Name	Description
Public method	DocumentationHelper

Methods

	Name	Description
Public method Static member	GetDocumentationRootUrl	Gets URL for product documentation root.
Protected method	GetDocumentationRootUrlInternal	Gets URL for product documentation root.
Public method Static member	GetDocumentationSearchUrlPattern	Gets URL pattern for product documentation search. Pass searched text as 0th substitution.
Protected method	GetDocumentationSearchUrlPatternInternal	Gets URL pattern for product documentation search. Pass searched text as 0th substitution.
Public method Static member	GetDocumentationTopicUrl	Gets URL for product documentation topic. Topic is either a topic ID, or an absolute URL.
Protected method	GetDocumentationTopicUrlInternal	Gets URL for product documentation topic. Topic is either a topic ID, or an absolute URL.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)

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.)