HTMLIFrameElement

The HTMLIFrameElement interface provides special properties and methods (beyond those of the HTMLElement interface it also has available to it by inheritance) for manipulating the layout and presentation of inline frame elements.

Properties

Inherits properties from its parent, HTMLElement.

HTMLIFrameElement.align

Is a DOMString that specifies the alignment of the frame with respect to the surrounding context.

HTMLIFrameElement.allowfullscreen

Is a Boolean that indicates whether or not the inline frame is willing to be placed into full screen mode. See Using full-screen mode for details.

HTMLIFrameElement.contentDocument Read only

Returns a Document, the active document in the inline frame's nested browsing context.

HTMLIFrameElement.contentWindow Read only

Returns a WindowProxy, the window proxy for the nested browsing context.

HTMLIFrameElement.frameBorder

Is a DOMString that indicates whether to create borders between frames.

HTMLIFrameElement.height

Is a DOMString that reflects the height HTML attribute, indicating the height of the frame.

HTMLIFrameElement.longDesc

Is a DOMString that contains the URI of a long description of the frame.

HTMLIFrameElement.marginHeight

Is a DOMString being the height of the frame margin.

HTMLIFrameElement.marginWidth

Is a DOMString being the width of the frame margin.

HTMLIFrameElement.name

Is a DOMString that reflects the name HTML attribute, containing a name by which to refer to the frame.

HTMLIFrameElement.sandbox

Is a DOMSettableTokenList that reflects the sandbox HTML attribute, indicating extra restrictions on the behavior of the nested content.

HTMLIFrameElement.scrolling

Is a DOMString that indicates whether the browser should provide scrollbars for the frame.

HTMLIFrameElement.seamless

Is a Boolean that reflects the seamless HTML attribute, indicating that the inline frame should be rendered seamlessly within the parent document.

HTMLIFrameElement.src

Is a DOMString that reflects the src HTML attribute, containing the address of the content to be embedded.

HTMLIFrameElement.srcdoc

Is a DOMString that represents the content to display in the frame.

HTMLIFrameElement.width

Is a DOMString that reflects the width HTML attribute, indicating the width of the frame.

Methods

Inherits properties from its parent, HTMLElement.

HTMLIFrameElement.setNfcFocus Firefox OS 2.2+ Only

Part of the Firefox OS Browser API, this sets whether an <iframe> can receive an NFC event.

Specifications

Browser compatibility

[1] Previously, the type of sandbox was a DOMString instead of a DOMSettableTokenList. This has been fixed with Gecko 29.0 (Firefox 29 / Thunderbird 29 / SeaMonkey 2.26)) (bug 845067). Other browsers may still implement the property as DOMString since it was a late change in the specification.

Firefox OS notes

Firefox OS extend the HTMLIFrameElement interface to support browser iframes. Those extra methods are made for privileged applications which want to implement a browser like application for Firefox OS devices. Not that in that context, the HTMLIFrameElement also inherit methods from the EventTarget interface. To learn how to implement such applications, see the Using the Browser API article.

HTMLIFrameElement.setVisible(visible)

Allows the parent to explicitly change the visibility state of the browser iframes.

HTMLIFrameElement.getVisible()

Returns the current visibility state of the browser iframe. Returns a DOMRequest.

HTMLIFrameElement.sendMouseEvent(type, x, y, button, clickCount, modifiers)

Send a mouse event to the browser iframe.

HTMLIFrameElement.sendTouchEvent(type, identifiers, touchesX, touchesY,radiisX, radiisY, rotationAngles, forces,count, modifiers)

Send a touch event to the browser iframe.

HTMLIFrameElement.goBack()

Navigate the browser iframe back.

HTMLIFrameElement.goForward()

Navigate the browser iframe forward.

HTMLIFrameElement.reload()

Reload the browser iframe.

HTMLIFrameElement.stop()

Stop loading the browser iframe content.

HTMLIFrameElement.purgeHistory()

Allows to remove the all browsing history of the browser iframe.

HTMLIFrameElement.getScreenshot(maxWidth, maxHeight)

Allows to take a screenshot of the browser iframe's content, scaled to fit within maxWidth and maxHeight pixels. Returns a DOMRequest.

HTMLIFrameElement.addNextPaintListener()

Add a listener to recieve an event the first time the browser iframe is ready to paint (This listener is sent an event after the first MozAfterPaint event is dispacted in the iframe.)

HTMLIFrameElement.removeNextPaintListener()

Remove the listener added by the previous function.

HTMLIFrameElement.getCanGoBack()

Returns a DOMRequest which result is a boolean indicating wether the browser iframe can be navigate backward.

HTMLIFrameElement.getCanGoForward()

Returns a DOMRequest which result is a boolean indicating wether the browser iframe can be navigate forward.

See also

• The HTML element implementing this interface: <iframe>