CMSDocumentRouteConstraint Class

Constraint to check the context of a document in the web site.

Inheritance Hierarchy

System.Object
  CMS.URLRewritingEngine.BaseDocumentConstraint
    CMS.URLRewritingEngine.CMSDocumentRouteConstraint

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

Syntax

public class CMSDocumentRouteConstraint : BaseDocumentConstraint, 
	IRouteConstraint

The CMSDocumentRouteConstraint type exposes the following members.

Constructors

	Name	Description
Public method	CMSDocumentRouteConstraint	Constructor

Methods

	Name	Description
Protected method	GetPageInfo	Gets the page info with the correct PageResult object for the given url. (Inherited from BaseDocumentConstraint.)
Protected method	CheckCulture	Validates the culture of the request against the constraint (Inherited from BaseDocumentConstraint.)
Protected method	CheckSite	Validates current site against the constraint (Inherited from BaseDocumentConstraint.)
Public method	Match	Returns true if the route matches the context.
Protected method	PreProcess	Preprocesses the constraint, matches the site name and culture, and attempts to send output from cache (Inherited from BaseDocumentConstraint.)

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

Fields

	Name	Description
Protected field	mAliasPath	Alias path for the current handler (Inherited from BaseDocumentConstraint.)
Protected field	mCulture	Culture for the current handler (Inherited from BaseDocumentConstraint.)
Protected field	mNodeId	Node ID for the current handler (Inherited from BaseDocumentConstraint.)
Protected field	mPageInfoSource	Page info source (Inherited from BaseDocumentConstraint.)
Protected field	mSiteName	Site name for the current handler. (Inherited from BaseDocumentConstraint.)
Protected field	mUrlPath	Url path (Inherited from BaseDocumentConstraint.)

Properties

	Name	Description
Public property	SwitchToRouteCulture	If true (default), the routing behaves the same way as URL path = switches the current culture to the route culture (Inherited from BaseDocumentConstraint.)