GetDocLinkHandler Class

Handles requests for documentation. Redirects the client to documentation service with proper product version specified.

Accessing the handler without "link" query parameter specified redirects the client to product documentation root. Accessing the handler with "link" query parameter redirects the client to documentation topic identified by "link".

Inheritance Hierarchy

System.Object
  CMS.PortalEngine.GetDocLinkHandler

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

Syntax

public class GetDocLinkHandler : IHttpHandler

The GetDocLinkHandler type exposes the following members.

Constructors

	Name	Description
Public method	GetDocLinkHandler

Methods

	Name	Description
Public method	ProcessRequest	Processes the documentation request.

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

Properties

	Name	Description
Public property	IsReusable	The handler is reusable.

Remarks

The handler is designed as reusable and therefore must be thread-safe. Keep that in mind when making any modifications.