Your Search Results

    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.

    Name Type Description
    align  DOMString Specifies the alignment of the frame with respect to the surrounding context.
    allowfullscreen  Boolean Indicates whether or not the inline frame is willing to be placed into full screen mode. See Using full-screen mode for details.
    contentDocument Read only Document The active document in the inline frame's nested browsing context.
    contentWindow Read only WindowProxy The window proxy for the nested browsing context.
    frameborder  DOMString Indicates whether to create borders between frames.
    height DOMString Reflects the height HTML attribute, indicating the height of the frame.
    longDesc  DOMString URI of a long description of the frame.
    marginHeight  DOMString Height of the frame margin.
    marginWidth  DOMString Width of the frame margin.
    name DOMString Reflects the name HTML attribute, containing a name by which to refer to the frame.
    sandbox DOMSettableTokenList [1] Reflects the sandbox HTML attribute, indicating extra restrictions on the behavior of the nested content.
    scrolling  DOMString Indicates whether the browser should provide scrollbars for the frame.
    seamless  Boolean Reflects the seamless HTML attribute, indicating that the inline frame should be rendered seamlessly within the parent document.
    src DOMString Reflects the src HTML attribute, containing the address of the content to be embedded.
    srcDoc DOMString The content to display in the frame.
    width DOMString Reflects the width HTML attribute, indicating the width of the frame.

    Methods

    No specific method; inherits properties from its parent, HTMLElement.

    Specifications

    Specification Status Comment
    WHATWG HTML Living Standard
    The definition of 'HTMLIFrameElement' in that specification.
    Living Standard The following property has been added: allowFullscreen.
    HTML5
    The definition of 'HTMLIFrameElement' in that specification.
    Candidate Recommendation The following properties are now obsolete: scrolling, marginWidth, marginHeight, longDesc, frameBorder, and align.
    The following properties have been added: srcdoc, sandbox, seamless, and contentWindow.
    Document Object Model (DOM) Level 2 HTML Specification
    The definition of 'HTMLIFrameElement' in that specification.
    Recommendation The contentDocument property has been added.
    Document Object Model (DOM) Level 1 Specification
    The definition of 'HTMLIFrameElement' in that specification.
    Recommendation Initial definition.

    Browser compatibility

    Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
    Basic support (Yes) 1.0 (1.7 or earlier) (Yes) (Yes) (Yes)
    srcdoc 4 25 (25) ? ? ?
    sandbox 4 17 (17) [1] ? ? ?
    seamless 4 Not supported ? ? ?
    contentDocument (Yes) (Yes) 8.0 (for older version use HTMLIFrameElement.contentWindow.document instead) (Yes) (Yes)
    contentWindow ? ? (Yes) ? ?
    allowFullScreen 17 -webkit
    Daily test builds only
    9.0 (9.0) -moz
    18.0 (18.0)
    Not supported Not supported Not supported
    Feature Android Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
    Basic support (Yes) 1.0 (1.0) (Yes) (Yes) (Yes)
    srcdoc 4 25.0 (25) ? ? ?
    sandbox 4 17.0 (17) [1] ? ? ?
    seamless 4 Not supported ? ? ?
    contentDocument (Yes) (Yes) ? (Yes) (Yes)
    contentWindow ? ? ? ? ?
    allowFullScreen 17 -webkit
    Daily test builds only
    9.0 (9.0) -moz
    18.0 (18.0)
    Not supported Not supported Not supported

    [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>

    Document Tags and Contributors

    Contributors to this page: Sheppy, fscholz, ethertank, jswisher, Nickolay, kscarfone, Yoshino, teoli, Jeremie
    Last updated by: teoli,