Class DocumentationHelper

Namespace

CMS.Helpers

Assembly

CMS.Helpers.dll

Helper methods for documentation links.

[Obsolete("Class was not intended for public use and will be removed.")]
[ObsoleteSince(29, 6)]
public class DocumentationHelper : AbstractHelper<DocumentationHelper>

Inheritance

object

CoreMethods

AbstractHelper

AbstractHelper<DocumentationHelper>

DocumentationHelper

Inherited Members

AbstractHelper<DocumentationHelper>.HelperObject

AbstractHelper<DocumentationHelper>.SetAsDefaultHelper()

CoreMethods.GetString(string, string)

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

GetDocumentationRootUrl()

Gets URL for product documentation root.

public static string GetDocumentationRootUrl()

Returns

string

URL for product documentation root.

GetDocumentationRootUrlInternal()

Gets URL for product documentation root.

protected virtual string GetDocumentationRootUrlInternal()

Returns

string

URL for product documentation root.

GetDocumentationSearchUrlPattern()

Gets URL pattern for product documentation search. Pass searched text as 0th substitution.

public static string GetDocumentationSearchUrlPattern()

Returns

string

URL pattern for product documentation search

GetDocumentationSearchUrlPatternInternal()

Gets URL pattern for product documentation search. Pass searched text as 0th substitution.

protected virtual string GetDocumentationSearchUrlPatternInternal()

Returns

string

URL pattern for product documentation search

GetDocumentationTopicUrl(string)

Gets URL for product documentation topic. Topic is either a topic ID, or an absolute URL.

public static string GetDocumentationTopicUrl(string topic)

Parameters

topic string

Topic identifier or permanent link to documentation topic.

Returns

string

URL for product documentation topic

GetDocumentationTopicUrlInternal(string)

Gets URL for product documentation topic. Topic is either a topic ID, or an absolute URL.

protected virtual string GetDocumentationTopicUrlInternal(string topic)

Parameters

topic string

Topic identifier or permanent link to documentation topic.

Returns

string

URL for product documentation topic