nsIScriptableUnescapeHTML

Implemented by: @mozilla.org/feed-unescapehtml;1 as a service:

var scriptableUnescapeHTML = Components.classes["@mozilla.org/feed-unescapehtml;1"]
                             .getService(Components.interfaces.nsIScriptableUnescapeHTML);

Method overview

Methods

parseFragment()

Parses a string of HTML or XML source into a sanitized DocumentFragment.

This is equivalent to calling nsIParserUtils::parseFragment(fragment, 0, isXML, baseURI, element). You should call nsIParserUtils::parseFragment() instead of calling this method.

nsIDOMDocumentFragment parseFragment(
  in AString fragment,
  in PRBool isXML,
  in nsIURI baseURI,
  in nsIDOMElement element
);

Parameters

fragment

A string of HTML or XML source to parse as a fragment.

isXML

Set this to true if the fragment is an XML string; otherwise set it to false.

baseURI

Pointer to the base URI against which to resolve any URIs included in the fragment. This parameter is ignored if isXML is false.

element

The nsIDOMElement to be used as the context node for the purposes of the fragment parsing algorithm.

Return value

An nsIDOMDocumentFragment of the element with the new text appended.

Exceptions thrown

NS_ERROR_FAILURE

Unable to append the text to the element.

unescape()

Convents HTML source into plain text.

This is equivalent to calling nsIParserUtils::convertToPlainText(src, nsIDocumentEncoder::OutputSelectionOnly | nsIDocumentEncoder::OutputAbsoluteLinks, 0). You should call nsIParserUtils::convertToPlainText() instead of calling this method.

AString unescape(
  in AString src
);

Parameters

src

The HTML string to convert into plain text.

Return value

The result of the plain text conversion.

Exceptions thrown

NS_ERROR_FAILURE

Unable to convert the string.

See also

• nsIDOMDocumentFragment
• nsIURI
• nsIDOMElement