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: 12.0.0

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