DocumentURLProvider Class

URL provider for the documents.

Inheritance Hierarchy

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

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

Syntax

public class DocumentURLProvider : AbstractURLProvider<DocumentURLProvider>

The DocumentURLProvider type exposes the following members.

Constructors

	Name	Description
Public method	DocumentURLProvider

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	GetPermanentDocUrl	Returns permanent document URL.
Protected method	GetPermanentDocUrlInternal	Returns permanent document URL.
Public method Static member	GetUrl	Returns URL for the specified aliasPath and urlPath (preferable if urlpath is not wildcard URL) and a specified site name.
Protected method	GetUrlForPathInternal	Returns URL for the specified path.
Protected method	GetUrlInternal	Returns URL for the specified aliasPath and urlPath (preferable if urlpath is not wildcard URL) and a specified site name.
Public method Static member	UsePermanentUrls	Indicates if permanent URLs should be generated for documents and attachments

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
Public field Static member	DEFAUL_PAGE_DEFAULT	Use default page URL
Public field Static member	DEFAUL_PAGE_DOMAIN	Use domain for default page
Public field Static member	DEFAUL_PAGE_NONE	Do not process default page
Public field Static member	DEFAUL_PAGE_PAGE	Use default alias path page
Public field Static member	DOMAIN_PREFIX_NONE	Do not process domain prefix
Public field Static member	DOMAIN_PREFIX_WITHOUTWWW	Never use www prefix for domains
Public field Static member	DOMAIN_PREFIX_WWW	Always use www prefix for domains
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 widcard value.
Public property Static member	WildcardRegex	Gets the regular expression for wildcard rule.