URLHelper Class

Url processing methods.

Inheritance Hierarchy

System.Object
  CMS.Helpers.URLHelper

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

Syntax

public class URLHelper

The URLHelper type exposes the following members.

Constructors

	Name	Description
Public method	URLHelper

Methods

	Name	Description
Public method Static member	AddHTTPToUrl	Adds HTTP protocol to URL if it's not contain HTTP or HTTPS.
Public method Static member	AddParameterToUrl	Adds parameter to specified URL.
Public method Static member	AddPrefixToUrl	Add URL prefix to the url.
Public method Static member	AddUrlParameter	Add parameter to query string, queryStringValue MUST start with "?".
Public method Static member	AppendQuery	Appends the given query string to the URL. If the URL already contains query string, merges both.
Public method Static member	ClientRedirect	Performs client redirect.
Public method Static member	CombinePath	Resolves given path to be absolute (combines with given paths).
Public method Static member	ContainsProtocol	Returns true if the URL contains the protocol part.
Public method Static member	CorrectDomainName	Removes white characters from the beginning and end. Also removes protocol declarations and 'www.' string from begin.
Public method Static member	DomainMatch	Returns true if the given domain names match.
Public method Static member	EncodeQueryString	Obsolete. Encodes QueryString part of URL with HTML encode.
Public method Static member	EnsureHashToQueryParameters	Replaces {hash} macro by hash code for given query string parameters.
Public method Static member	EnsureURLPrefix(String, String, String)	Ensures that the given URLs has the given prefix
Public method Static member	EnsureURLPrefix(String, String, String, URLHelper.PathModifierHandler)	Ensures that the given URLs has the given prefix
Public method Static member	EscapeSpecialCharacters	Ensures URL without forbidden characters (%, &, #).
Public method Static member	ForbiddenCharactersReplacement	Returns string containing replacement for forbidden characters (chars that can't be used in node alias and in the file system).
Public method Static member	ForbiddenURLCharacters	Returns string containing all forbidden characters that cannot be used in node alias and in the file system.
Public method Static member	GetAbsoluteUrl(String)	Returns the absolute URL (including port) representation for the given relative URL, uses current domain and application path.
Public method Static member	GetAbsoluteUrl(String, String)	Returns the absolute URL (including port) representation for the given relative URL, uses given domain and application path.
Public method Static member	GetAbsoluteUrl(String, String, String, String)	Returns the absolute URL for the given relative URL based on the given paths.
Public method Static member	GetAbsoluteUrlWithPort	Obsolete. Returns the absolute URL (including port) representation for the given relative URL, uses current domain and application path.
Public method Static member	GetAllowedURLCharacters	Returns regular expression for allowed URL characters.
Public method Static member	GetApplicationUrl()	Returns current application URL (absolute), without trailing slashes.
Public method Static member	GetApplicationUrl(String)	Returns the application URL (absolute), without trailing slashes.
Public method Static member	GetAppRelativePath	Returns the relative path for specified URL.
Public method Static member	GetCaseRedirectEnum	Gets the settings for the URL case rules.
Public method Static member	GetDomain	Returns domain or domain with port if present from specific URL.
Public method Static member	GetDomainName	Returns name (e.g. localhost) without port, www. prefix and application path.
Public method Static member	GetFriendlyExtension	Returns first of the friendly extensions from settings.
Public method Static member	GetFriendlyExtensions	Returns string with all friendly URL extensions separated by semicolon.
Public method Static member	GetFullApplicationUrl()	Returns current application URL (absolute) with port, without trailing slashes.
Public method Static member	GetFullApplicationUrl(String)	Returns current application URL (absolute) with port, without trailing slashes.
Public method Static member	GetHandledUrl	Returns the URL handled by handler404 page.
Public method Static member	GetIPv4Address	Returns equivalent IPv4 address for IPv6 address specified by parameter
Public method Static member	GetPhysicalPath	Returns the physical file path that corresponds to the specified virtual path on the web server.
Public method Static member	GetProtocol	Returns protocol from url. e.g. http, https, ftp, ... If no protocol found, null is returned.
Public method Static member	GetQuery	Gets the query from URL.
Public method Static member	GetQueryValue(String, String)	Gets the query string value for specified key name.
Public method Static member	GetQueryValue(String, String, Boolean)	Gets the query string value for specified key name.
Public method Static member	GetSafeFileName(String, String)	Returns the safe equivalent to the given file name (with extension).
Public method Static member	GetSafeFileName(String, String, Boolean)	Returns the safe equivalent to the given file name.
Public method Static member	GetSafeUrlPart	Returns the safe part of URL. This method doesn't proceed complete URL it handles only part of URL.
Public method Static member	GetUrlExtension	Gets the extension for the given URL. Returns the extension with the dot, e.g. ".gif"
Public method Static member	GetUrlParameter	Returns value of query parameter from URL.
Public method Static member	GetVirtualPath	Converts the absolute path to the virtual.
Public method Static member	CheckPrefix	Checks the URL prefix. If the prefix is present, returns true and removes the prefix from the URL if removePrefix is true.
Public method Static member	CheckPrefixes	Checks the URL prefixes. If one of the the prefixes is present, returns true and removes the prefix from the URL if removePrefix is true.
Public method Static member	IsAnchor	Returns true for url's starting with hash (#) character.
Public method Static member	IsExcluded(String, String)	Checks if page with specified relative path is excluded from excluded paths.
Public method Static member	IsExcluded(String, String[])	Checks if page with specified relative path is excluded from excluded paths.
Public method Static member	IsExcludedCustom	Checks if page with specified relative path is excluded from excluded paths.
Public method Static member	IsExcludedSystem	Checks if page with specified relative path is excluded from system paths.
Public method Static member	IsExcludedSystemEnum	Checks if page with specified relative path is excluded from system paths and returns the category of the excluded page.
Public method Static member	IsHandler	Checks if page is error handler.
Public method Static member	IsLocalUrl	Returns true if the given URL is located on current server.
Public method Static member	IsPostback	Returns true if current request is post-back.
Public method Static member	IsSystemPath	Returns true if the given path is a system path. The path is expected to be lowercase and start with slash, e.g. "/cmsmodules/..."
Public method Static member	IsTldDomain	Returns true if domain is IP address or top level domain e.g localhost
Public method Static member	LimitURLReplacements	Limits multiple replacements, starting and trailing replacements from URL. Can be disabled by app key: CMSLimitUrlReplacement.
Public method Static member	MakeLinksAbsolute(String)	Returns the absolute representation of the HTML links (image paths ...).
Public method	MakeLinksAbsolute(String, String)	Returns the absolute representation of the HTML links (image paths ...).
Public method Static member	MergeQueryStrings	Merges two query strings. Query string parameters should (but don't have to) start with question mark but they definitely must omit path part of URL.
Public method Static member	PermanentRedirect	Obsolete. Redirects the response using specified URL using permanent redirection using 301.
Public method Static member	PropagateUrlParameters	Propagates the URL parameters from current URL to the given URL
Public method Static member	Redirect(String)	Redirects the response using specified URL (302 HTTP status code).
Public method Static member	Redirect(String, Boolean, String)	Obsolete. Redirects the response using specified URL.
Public method Static member	RedirectPermanent	Redirects the response using specified URL using permanent redirection using 301.
Public method Static member	RefreshCurrentPage	Refreshes the current page by doing a redirect to self
Public method Static member	RemoveApplicationPath	Removes the Application path from the URL.
Public method Static member	RemoveEmptyQueryParameters	Removes empty query parameters. (eg. '?param=' -> '')
Public method Static member	RemoveExtension	Removes the potential extension from the given path.
Public method Static member	RemoveFirstPart	Returns the string with first selector removed.
Public method Static member	RemoveParameterFromUrl	Removes specified parameters from the given URL.
Public method Static member	RemoveParametersFromUrl	Removes specified parameters from the given URL.
Public method Static member	RemovePathInfo	Removes the path info from URL.
Public method Static member	RemovePort	Removes the port part from the domain name.
Public method Static member	RemovePortFromURL	Removes the port part from the whole URL.
Public method Static member	RemoveProtocol	Removes the protocol part from the URL.
Public method Static member	RemoveProtocolAndDomain	Removes the protocol and domain part from the URL.
Public method Static member	RemoveQuery	Removes the query from URL.
Public method Static member	RemoveTrailingSlashFromURL	Removes trailing slash from URL.
Public method Static member	RemoveUrlParameter	Remove parameter from query string.
Public method Static member	RemoveUrlParameters	Removes the given URL parameters
Public method Static member	RemoveWWW	Trim www if input text starts with it.
Public method Static member	ResolveClientUrl	Resolves a client relative URL to the absolute form.
Public method Static member	ResolveUrl	Resolves an application relative URL to the absolute form.
Public method Static member	ResponseRedirect	Redirects the response using specified URL using standard redirection with Response.Redirect.
Public method Static member	SeeOther	Redirects the client to another URL using the GET method (303 H).
Public method Static member	UnMapPath	Converts the physical file path to virtual path within the web application.
Public method Static member	UnResolveUrl	Un-resolves the given URL (replaces application path with ~).
Public method Static member	UpdateParameterInUrl	Update parameter in specified URL.
Public method Static member	URLDecode	URL decoding function.
Public method Static member	URLEncode	URL encoding function.
Public method Static member	UrlEncodeQueryString	URL encodes query string in given URL. Needs HttpContext.
Public method Static member	UseLangPrefixForUrls	Returns value that indicates whether lang prefix should be used for specified site.
Public method Static member	UsePermanentRedirect	If true, permanent redirection (301) is used instead of regular (302) redirection.
Public method Static member	UseURLsWithTrailingSlash	Gets the settings for the URL trailing slash rules.

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	SYSTEM_QUERY_PARAMETER	Used in system requests of live site pages, it prevents the system to log statistics or activities, e.g. when dynamic newsletter is generated.

Properties

	Name	Description
Public property Static member	AliasPathParameterName	Alias path query parameter name.
Public property Static member	AllowedURLPathValues	Returns string containing allowed characters that cant be used in URL path.
Public property Static member	CustomTheme	Custom theme name.
Public property Static member	DefaultTheme	Default theme name.
Public property Static member	ImagesDirectory	Resolved base directory for the images.
Public property Static member	LanguageParameterName	Language query parameter name.
Public property Static member	PortalTemplatePage	Page used as the portal template base page
Public property Static member	RegExMakeLinksAbsolute	Make links absolute regular expression.
Public property Static member	SSLUrlPort	Application's SSL URL port.
Public property Static member	UrlPort	Application's URL port.
Public property Static member	UseTrailingSlashOnlyForExtensionLess	Gets the value that indicates whether trailing slash handling should be processed for all requests or only for extension less requests

Events

	Name	Description
Public event Static member	OnBeforeGetSafeUrlPath	Occurs when the GetSafeUtlPath method is called, returns false if original method should not be used.