Click or drag to resize
DocumentURLProvider Class
URL provider for the documents.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractBaseProviderDocumentURLProvider
    CMS.DocumentEngineDocumentURLProvider

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 12.0.0
Syntax
C#
public class DocumentURLProvider : AbstractBaseProvider<DocumentURLProvider>

The DocumentURLProvider type exposes the following members.

Constructors
  NameDescription
Public methodDocumentURLProvider
Top
Fields
  NameDescription
Public fieldStatic memberDEFAULT_PAGE_DEFAULT
Use default page URL
Public fieldStatic memberDEFAULT_PAGE_DOMAIN
Use domain for default page
Public fieldStatic memberDEFAULT_PAGE_NONE
Do not process default page
Public fieldStatic memberDEFAULT_PAGE_PAGE
Use default alias path page
Public fieldStatic memberNO_EXTENSION
No extension constant
Top
Properties
  NameDescription
Public propertyStatic memberDefaultPageURL
Default (root) page URL.
Public propertyStatic memberUseCurrentWildcardValueAsDefaultValue
Gets or sets the value that indicates whether current wildcard query string value should be used as default value.
Public propertyStatic memberWildcardDefaultValueDelimiter
Gets the delimiter for default wildcard value.
Public propertyStatic memberWildcardRegex
Gets the regular expression for wildcard rule.
Top
Methods
  NameDescription
Public methodStatic memberBuildWildcardQueryString
Returns query string for wildcard url. Wildcard is in format /{name
Public methodStatic memberEnsureDomainPrefix
Ensures domain prefix with dependence on specified site setting
Protected methodEnsureDomainPrefixInternal
Ensures domain prefix with dependence on specified site setting
Public methodStatic memberEnsureWildcardPath
Ensures URL path with wildcards. The wildcard with default value are replace to the default value.
Public methodStatic memberGetAbsoluteLiveSiteURL
Gets absolute live site URL according to SSL option of node and ensure proper port if custom port for Http/Https is defined.
Public methodStatic memberGetDocumentCultureUrls
Creates culture version of URLs for given node based on provided parameters.
Public methodStatic memberGetExtension
Returns extension for given document. Takes document custom extensions and also 'Files friendly URL extension' and 'Friendly URL extensions' settings into account.
Public methodStatic memberGetNavigationUrl
Returns resolved (absolute) URL of a page represented by data container. Method reflects page navigation settings.
Public methodStatic memberGetPermanentDocUrl
Returns permanent document URL.
Protected methodGetPermanentDocUrlInternal
Returns permanent document URL.
Public methodStatic memberGetPresentationUrl
Returns presentation URL for the specified node. This is the absolute URL where live presentation of given node can be found.
Public methodStatic memberGetPresentationUrlHandlerPath
Returns a relative URL path to PresentationUrlRedirect handler with parameters based on which the live page URL can be generated when needed.
Protected methodGetPresentationUrlInternal
Returns presentation URL for the specified node. This is the absolute URL where live presentation of given node can be found.
Public methodStatic memberGetUrl(TreeNode)
Returns relative URL for the specified tree node.
Public methodStatic memberGetUrl(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 methodGetUrlInternal(TreeNode)
Returns relative URL for the specified tree node.
Protected methodGetUrlInternal(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 methodSetAsDefaultProvider
Sets this object as the default provider
(Inherited from AbstractBaseProviderProviderType.)
Public methodStatic memberUsePermanentUrls
Indicates if permanent URLs should be generated for documents and attachments
Top
Events
  NameDescription
Public eventStatic memberOnGetABTestOriginalVariant
Delegates retrieving of original variant node (if the node is AB test variant) to external handler.
Top
See Also