AlternativeUrlHelper Class

Helper methods for alternative URLs.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<AlternativeUrlHelper>
        CMS.DocumentEngine.Internal.AlternativeUrlHelper

Namespace: CMS.DocumentEngine.Internal
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131

Syntax

public class AlternativeUrlHelper : AbstractHelper<AlternativeUrlHelper>

The AlternativeUrlHelper type exposes the following members.

Constructors

	Name	Description
Public method	AlternativeUrlHelper

Methods

	Name	Description
Protected method	FindConflictingPage	Returns a page that is in conflict with AlternativeUrlInfo represented by alternativeUrlSegments.
Public method Static member	GetConflictingAlternativeUrl(AlternativeUrlInfo)	Returns AlternativeUrlInfo that has the same URL on the same site as given alternativeUrl.
Public method Static member	GetConflictingAlternativeUrl(TreeNode)	Returns alternative URL that is in conflict with given node. Alternative URL is in conflict with the node when their URLs match.
Protected method	GetConflictingAlternativeUrlInternal(AlternativeUrlInfo)	Returns AlternativeUrlInfo that has the same URL on the same site as given alternativeUrl.
Protected method	GetConflictingAlternativeUrlInternal(TreeNode)	Returns alternative URL that is in conflict with given node. Alternative URL is in conflict with the node when their URLs match.
Public method Static member	GetConflictingExcludedUrl	Returns conflicting URL when given alternativeUrl matches any excluded URL defined in settings application or any system URL.
Protected method	GetConflictingExcludedUrlInternal	Returns conflicting URL when given alternativeUrl matches any excluded URL defined in settings application or any system URL.
Public method Static member	GetConflictingPage	Returns a page that is in conflict with given alternativeUrlInfo. Page is in conflict with the alternativeUrlInfo when their URLs match.
Protected method	GetConflictingPageInternal	Returns a page that is in conflict with given alternativeUrl. Page is in conflict with the alternativeUrl when their URLs match.
Public method Static member	GetDocumentIdentification	Returns human-readable document identification for given documentName and documentCulture.
Protected method	GetDocumentIdentificationInternal	Returns human-readable document identification for given documentName and documentCulture.
Public method Static member	GetMainDocument	Returns main document of given alternativeUrl.
Protected method	GetMainDocumentInternal	Returns main document of given alternativeUrl.
Public method Static member	IsAlternativeUrlsSiteConflict	Checks whether the given site contains any of the alternative URLs defined for the given page or its child pages in all cultures.
Protected method	IsAlternativeUrlsSiteConflictInternal	Checks whether the given site contains any of the alternative URLs defined for the given page or its child pages in all cultures.
Public method Static member	IsAlternativeUrlUIEnabled	Indicates if the alternative URLs UI is enabled for given site.
Protected method	IsInCollision	Returns true, if page is in conflict with alternative URL represented by alternativeUrlSegments.
Public method Static member	MatchesAnyExcludedUrl	Returns true if alternativeUrl matches any excluded URL defined in settings application.
Protected method	MatchesAnyExcludedUrlInternal	Returns true if alternativeUrl matches any excluded URL defined in settings application.
Public method Static member	NormalizeAlternativeUrl	Ensures correct format of the alternativeUrl.
Protected method	NormalizeAlternativeUrlInternal	Ensures correct format of the alternativeUrl.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)
Public method Static member	UrlMatchesConstraint	Returns true if alternativeUrl matches allowed alternative URL constraint defined in settings application.
Protected method	UrlMatchesConstraintInternal	Returns true if alternativeUrl matches allowed alternative URL constraint defined in settings application.