HTMLHelper Class

HTML utility methods.

Inheritance Hierarchy

System.Object
  CMS.Helpers.HTMLHelper

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

Syntax

public static class HTMLHelper

The HTMLHelper type exposes the following members.

Methods

	Name	Description
Public method Static member	AddToHeader	Adds the given HTML code to the header of the page.
Public method Static member	EncodeAngleBrackets	Obsolete. Replace angle brackets with HTML encode entity (</>)
Public method Static member	EncodeForHtmlAttribute	Encodes string to be used as the HTML attribute value.
Public method Static member	EncodeLinkReference	Obsolete. Encodes URL in order to be used as href parameter in link.
Public method Static member	EncodeQuotes	Obsolete. Replace quote characters (double or simple) with HTML encode entity ("/")
Public method Static member	EnsureLineEnding	Ensures proper line ending within the given string.
Public method Static member	EnsureURLPrefixes(String, String, String)	Ensures that all local URLs have given prefix
Public method Static member	EnsureURLPrefixes(String, String, String, URLHelper.PathModifierHandler)	Ensures that all local URLs have given prefix
Public method Static member	FixFormAction(String, String)	Fixes the form action attribute within given HTML code.
Public method Static member	FixFormAction(String, String, Boolean, Boolean)	Fixes the form action attribute within given HTML code.
Public method Static member	FixFormAction(String, String, Boolean, Boolean, String)	Fixes the form action attribute within given HTML code.
Public method Static member	FixRTLText	Fixes RTL text. Adds special marks at the end (at the beginning) of the text if it ends (starts) with weak unicode symbol.
Public method Static member	FixUrl	Fixes the URL within given HTML code. The output code is HTML valid. It changes '&' to '&amp;' and backwards if needed. '?test=1&test2=2' is changed to '?test=1&amp;test2=2' '&amp;#13;' is changed to '&#13;'. '&amp;lt;' is changed to '&lt;'.
Public method Static member	FixViewstate	Fixes the view state tag within given HTML code.
Public method Static member	FixXHTML	Performs the HTML code fix to become valid XHTML. Method for complete fix solution.
Public method Static member	GetAttributeValue	Gets the value of the HTML element's attribute.
Public method Static member	GetConvertTableEnum	Converts the string representation to the ConvertTableEnum
Public method Static member	GetCSSFileLink	Obsolete. Returns the HTML code for the CSS style link.
Public method Static member	GetFormAction	Gets the form action for the current request.
Public method Static member	GetLink	Returns the HTML link element that links to a related document.
Public method Static member	GetSafeColorFromHtml	Returns color from HTML string color definition.
Public method Static member	GetUniqueControlID	Gets the unique ID for the control, if some other control has the same base ID, adds the number at the end.
Public method Static member	HighlightHTML	Highlight HTML.
Public method Static member	HTMLDecode	HTML decoding function. Returns a string converted into an HTML-decoded string.
Public method Static member	HTMLEncode	HTML encoding function. Returns a string converted into an HTML-encoded string. Function does not encode previously encoded HTML entity (avoiding double HTML escaping).
Public method Static member	HTMLEncodeLineBreaks	HTML encoding function. HTML encodes given text and replaces standard line breaks with br tag.
Public method Static member	HtmlToPlainText	Converts HTML to the plain text (body part).
Public method Static member	LimitLength	Limits the string length.
Public method Static member	ReformatHTML(String)	Reformats the HTML code indentation.
Public method Static member	ReformatHTML(String, String)	Reformats the HTML code indentation.
Public method Static member	ReformatHTML(String, String, Int32)	Reformats the HTML code indentation.
Public method Static member	RemoveFormName	Removes form name tag from the given HTML code.
Public method Static member	RemoveScripts	Removes the scripts from the given HTML text.
Public method Static member	RemoveTitleId	Removes the title ID attribute from the HTML code.
Public method Static member	ReplaceTagParameter(String, String, String)	Replaces an attribute of a specified name inside an HTML element.
Public method Static member	ReplaceTagParameter(String, String, MatchEvaluator)	Replaces an attribute of a specified name inside an HTML element.
Public method Static member	ResolveCSSClientUrls	Resolves client-relative URLs in CSS rules to absolute URLs (used with css files).
Public method Static member	ResolveCSSUrls	Resolves application-relative URLs in CSS rules to absolute URLs (used with database style sheets).
Public method Static member	ResolveUrls(String, String)	Resolves relative URLs in given HTML(string). If CMSResolveAllUrls application settings is true it resolves all URLs. Otherwise it resolves URLs used in "src" or "href" or "background" attributes.
Public method Static member	ResolveUrls(String, String, Boolean)	Resolves relative URLs in given HTML(string). If CMSResolveAllUrls application settings is true it resolves all URLs. Otherwise it resolves URLs used in "src" or "href" or "background" attributes.
Public method Static member	SpanMsg	Returns span (of specified CSS class) containing message.
Public method Static member	StripTags(String, Boolean, String)	Remove HTML tags from text.
Public method Static member	StripTags(String, Boolean, Boolean, String, String, String)	Remove HTML tags from text.
Public method Static member	UnResolveUrls	Unresolve relative url if is use in "src" or "href".
Public method Static member	UseNoFollowForUsersLinks	Returns true if rel="nofollow" should be used for users link in forums, blog comments or message boards

Fields

	Name	Description
Public field Static member	DEFAULT_XMLNS_ATTRIBUTE	XMLNS attribute used in XHTML documents.
Public field Static member	DOCTYPE_HTML5	HTML 5 document type.
Public field Static member	mHandler404Page	Handler 404 page name.

Properties

	Name	Description
Public property Static member	QuickResolveUrls	If true, quick mode is used for resolving of the URLs.
Public property Static member	RegExFixAJAXFormAction	Regular expression to fix the form action parameter for AJAX request.
Public property Static member	RegExFixFormAction	Regular expression to fix the form action parameter.
Public property Static member	RegExHTMLEncode	Regular expression for HTML encoding.
Public property Static member	RegexHtmlToTextHead	Regular expression for removing entire head tag.
Public property Static member	RegexHtmlToTextScript	Regular expression for removing entire script tag.
Public property Static member	RegexHtmlToTextStyle	Regular expression for removing entire script tag.
Public property Static member	RegexHtmlToTextTags	Regular expression for removing tags but keeps their content.
Public property Static member	RegexHtmlToTextWhiteSpace	Regular expression for removing white spaces
Public property Static member	RegExLineEnd	Regular expression match for the end of the line.
Public property Static member	RegExResolveUrls	Regular expression for URL resolving.
Public property Static member	RegExStripTagsSpaces	Regular expression match for new lines and spaces between tags.
Public property Static member	UseExtensionOnPostback	Use extension on postback?