DocumentURLProvider Class

URL provider for the documents.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractBaseProvider<DocumentURLProvider>
    CMS.DocumentEngine.DocumentURLProvider

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 12.0.0

Syntax

public class DocumentURLProvider : AbstractBaseProvider<DocumentURLProvider>

The DocumentURLProvider type exposes the following members.

Constructors

	Name	Description
Public method	DocumentURLProvider

Fields

	Name	Description
Public field Static member	DEFAULT_PAGE_DEFAULT	Use default page URL
Public field Static member	DEFAULT_PAGE_DOMAIN	Use domain for default page
Public field Static member	DEFAULT_PAGE_NONE	Do not process default page
Public field Static member	DEFAULT_PAGE_PAGE	Use default alias path page
Public field Static member	NO_EXTENSION	No extension constant

Properties

	Name	Description
Public property Static member	DefaultPageURL	Default (root) page URL.
Public property Static member	UseCurrentWildcardValueAsDefaultValue	Gets or sets the value that indicates whether current wildcard query string value should be used as default value.
Public property Static member	WildcardDefaultValueDelimiter	Gets the delimiter for default wildcard value.
Public property Static member	WildcardRegex	Gets the regular expression for wildcard rule.

Methods

	Name	Description
Public method Static member	BuildWildcardQueryString	Returns query string for wildcard url. Wildcard is in format /{name
Public method Static member	EnsureDomainPrefix	Ensures domain prefix with dependence on specified site setting
Protected method	EnsureDomainPrefixInternal	Ensures domain prefix with dependence on specified site setting
Public method Static member	EnsureWildcardPath	Ensures URL path with wildcards. The wildcard with default value are replace to the default value.
Public method Static member	GetAbsoluteLiveSiteURL	Gets absolute live site URL according to SSL option of node and ensure proper port if custom port for Http/Https is defined.
Public method Static member	GetDocumentCultureUrls	Creates culture version of URLs for given node based on provided parameters.
Public method Static member	GetExtension	Returns extension for given document. Takes document custom extensions and also 'Files friendly URL extension' and 'Friendly URL extensions' settings into account.
Public method Static member	GetNavigationUrl	Returns resolved (absolute) URL of a page represented by data container. Method reflects page navigation settings.
Public method Static member	GetPermanentDocUrl	Returns permanent document URL.
Protected method	GetPermanentDocUrlInternal	Returns permanent document URL.
Public method Static member	GetPresentationUrl	Returns presentation URL for the specified node. This is the absolute URL where live presentation of given node can be found.
Public method Static member	GetPresentationUrlHandlerPath	Returns a relative URL path to PresentationUrlRedirect handler with parameters based on which the live page URL can be generated when needed.
Protected method	GetPresentationUrlInternal	Returns presentation URL for the specified node. This is the absolute URL where live presentation of given node can be found.
Public method Static member	GetUrl(TreeNode)	Returns relative URL for the specified tree node.
Public method Static member	GetUrl(String, String, String, String, String)	Returns URL for the specified aliasPath and urlPath (preferable if urlpath is not wildcard URL) and a specified site name.
Protected method	GetUrlInternal(TreeNode)	Returns relative URL for the specified tree node.
Protected method	GetUrlInternal(String, String, String, String, String)	Returns URL for the specified aliasPath and urlPath (preferable if urlpath is not wildcard URL) and a specified site name.
Public method	SetAsDefaultProvider	Sets this object as the default provider (Inherited from AbstractBaseProvider<ProviderType>.)
Public method Static member	UsePermanentUrls	Indicates if permanent URLs should be generated for documents and attachments

Events

	Name	Description
Public event Static member	OnGetABTestOriginalVariant	Delegates retrieving of original variant node (if the node is AB test variant) to external handler.