Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.
This API is available on Firefox OS for privileged or certified applications only.
The findAll()
method of the HTMLIFrameElement
searches for a string in a browser <iframe>
's text content; if found, the first instance of the string relative to the caret position will be highlighted.
Invoking this method results in a mozbrowserfindchange
event firing, which carries details about the search results.
Note: Use of the Browser API requires a privileged app, and browser
and/or embed-apps
permissions, depending on what you want to do. See Using the Browser API for more details.
SyntaxEdit
instanceOfHTMLIframeElement.findAll(searchString, caseSensitivity);
Returns
Void.
Parameters
- searchString
- The string you want to search for in the browser
<iframe>
's text. - caseSensitivity
- A string to declare whether you want the search to be case sensitive (
case-sensitive
) or insensitive (case-insensitive
.)
ExampleEdit
The following function is taken from our Browser API demo, and executes a search when a search form is submitted. See Implementing the search bar for more explanation.
searchForm.addEventListener('submit', function(e) {
e.preventDefault();
browser.findAll(searchBar.value, 'case-sensitive');
searchActive = true;
prev.disabled = false;
next.disabled = false;
searchBar.blur();
});
SpecificationEdit
Not part of any specification.