iframe element | iframe object

Creates inline floating frames.

Document Object Model (DOM) Level 2 HTML Specification, Section 1.6.5HTML 4.01 Specification, Section 16.5

HTML information

Closing Tagrequired
CSS Displayblock

DOM Information

Inheritance Hierarchy

 Node
  Element
   HTMLElement
     iframe

Members

The iframe object has these types of members:

Events

The iframe object has these events.

EventDescription
abort

Fires when the user aborts the download.

activate

Fires when the object is set as the active element.

blur

Fires when the object loses the input focus.

change

Fires when the contents of the object or selection have changed.

deactivate

Fires when the activeElement is changed from the current object to another object in the parent document.

error

Fires when an error occurs during object loading.

focus

Fires when the object receives focus.

input

Occurs when the text content of an element is changed through the user interface.

load

Fires immediately after the client loads the object.

onbeforedeactivate

Fires immediately before the activeElement is changed from the current object to another object in the parent document.

onselect

Fires when the current selection changes.

readystatechange

Fires when the state of the object has changed.

reset

Fires when the user resets a form.

resize

Fires when the size of the object is about to change.

scroll

Fires when the user repositions the scroll box in the scroll bar on the object.

 

Methods

The iframe object has these methods.

MethodDescription
appendChild

Appends an element as a child to the object.

applyElement

Makes the element either a child or parent of another element.

blur

Causes the element to lose focus and fires the onblur event.

clearAttributes

Removes all attributes and values from the object.

click

Simulates a click by causing the onclick event to fire.

cloneNode

Copies a reference to the object from the document hierarchy.

compareDocumentPosition

Compares the position of two nodes in a document.

componentFromPoint

Returns the component located at the specified coordinates via certain events.

contains

Checks whether the given element is contained within the object.

doScroll

Note   doScroll is no longer supported. Starting with IE11, use scrollLeft or scrollTop. For info, see Compatibility changes.

Simulates a click on a scroll bar component.

dragDrop

Initiates a drag event.

focus

Causes the element to receive the focus and executes the code specified by the onfocus event.

getAdjacentText

Returns the adjacent text string.

getAttribute

Retrieves the value of the specified attribute.

getAttributeNode

Retrieves an attribute object referenced by the attribute.name property.

getAttributeNodeNS

Gets an attribute object that matches the specified namespace and name.

getAttributeNS

Gets the value of the specified attribute within the specified namespace.

getElementsByClassName

Gets a collection of objects that are based on the value of the class attribute.

getElementsByTagName

Retrieves a collection of objects based on the specified element name.

getElementsByTagNameNS

Gets a collection of objects that are based on the specified element names within a specified namespace.

getSVGDocument

Gets Document object for the referenced document, or null if there is no document.

hasAttribute

Determines whether an attribute with the specified name exists.

hasAttributeNS

Determines whether an attribute that has the specified namespace and name exists.

hasAttributes

Determines whether one or more attributes exist for the object.

hasChildNodes

Returns a value that indicates whether the object has children.

insertAdjacentElement

Inserts an element at the specified location.

insertAdjacentHTML

Inserts the given HTML text into the element at the location.

insertAdjacentText

Inserts the given text into the element at the specified location.

insertBefore

Inserts an element into the document hierarchy as a child node of a parent object.

isDefaultNamespace

Indicates whether or not a namespace is the default namespace for a document.

isEqualNode

Determines if two nodes are equal.

isSameNode

Determines if two node references refer to the same node.

isSupported

Returns a value indicating whether or not the object supports a specific DOM standard.

lookupNamespaceURI

Gets the URI of the namespace associated with a namespace prefix, if any.

lookupPrefix

Gets the namespace prefix associated with a URI, if any.

mergeAttributes

Copies all read/write attributes to the specified element.

msMatchesSelector

Determines whether an object matches the specified selector.

normalize

Merges adjacent DOM objects to produce a normalized document object model.

removeAttribute

Removes an attribute from an object.

removeAttributeNode

Removes an attribute object from the object.

removeAttributeNS

Removes the specified attribute from the object.

removeChild

Removes a child node from the object.

removeNode

Removes the object from the document hierarchy.

replaceAdjacentText

Replaces the text adjacent to the element.

replaceChild

Replaces an existing child element with a new child element.

replaceNode

Replaces the object with another element.

scrollIntoView

Causes the object to scroll into view, aligning it either at the top or bottom of the window.

setActive

Sets the object as active without setting focus to the object.

setAttribute

Sets the value of the specified attribute.

setAttributeNode

Sets an attribute object node as part of the object.

setAttributeNodeNS

Sets an attribute object as part of the object.

setAttributeNS

Sets the value of the specified attribute within the specified namespace.

swapNode

Exchanges the location of two objects in the document hierarchy.

 

Properties

The iframe object has these properties.

PropertyAccess typeDescription

allowfullscreen

Enables content in an iframe to be displayed in full-screen mode.

allowTransparency

Sets or retrieves whether the object can be transparent.

ATOMICSELECTION

Specifies whether the element and its contents must be selected as a whole, indivisible unit.

attributes

Retrieves a collection of attributes of the object.

border (frame, iframe)

Sets or retrieves the space between the frames, including the 3-D border.

canHaveChildren

Gets a value indicating whether the object can contain child objects.

canHaveHTML

Retrieves the value indicating whether the object can contain rich HTML markup.

childElementCount

Retrieves the number of immediate child nodes of the current element or a zero if the element does not contain any child nodes. childElementCount does not return all child nodes, only child nodes that are nodeType =1, or element nodes.

className

Sets or retrieves the class of the object.

constructor

Returns a reference to the constructor of an object.

contentDocument

Retrieves the document object of the page or frame.

contentWindow

Retrieves the object of the specified .

dataFld

Sets or retrieves a field of a given data source, as specified by the dataSrc property, to bind to the specified object.

dataSrc

Sets or retrieves the source of the data for data binding.

firstChild

Gets a reference to the first child in the childNodes collection of the object.

firstElementChild

Retrieves a reference to the first child element, or NULL if there are no child elements.

frameSpacing

Sets or retrieves the amount of additional space between the frames.

height

Sets or retrieves the height of the object.

hideFocus

Sets or gets the value that indicates whether the object visibly shows that it has focus.

id

Sets or retrieves the string identifying the object.

innerHTML

Sets or retrieves the HTML between the start and end tags of the object.

innerText

Sets or retrieves the text between the start and end tags of the object.

isContentEditable

Gets the value that indicates whether the user can edit the contents of the object.

isDisabled

Gets the value that indicates whether the user can interact with the object.

isMultiLine

Retrieves the value indicating whether the content of the object contains one or more lines.

isTextEdit

Retrieves whether a TextRange object can be created using the object.

lang

Sets or retrieves the language to use.

lastChild

Gets a reference to the last child in the childNodes collection of an object.

lastElementChild

Retrieves a reference to the last child element or NULL if there are no child elements.

localName

Retrieves the local name of the fully qualified XML declaration for a node.

name

Sets or retrieves the frame name.

namespaceURI

Retrieves the namespace URI of the fully qualified XML declaration for a node.

nextElementSibling

Retrieves a reference to the sibling element that immediately follows or NULL if the element does not have any sibling elements that follow it.

nextSibling

Retrieves a reference to the next child of the parent for the object.

nodeName

Gets the name of a particular type of node.

nodeType

Retrieves the type of the requested node.

nodeValue

Gets or sets the value of a node.

noResize

Sets or retrieves whether the user can resize the frame.

offsetHeight

Retrieves the height of the object relative to the layout or coordinate parent, as specified by the offsetParent property.

offsetLeft

Retrieves the calculated left position of the object relative to the layout or coordinate parent, as specified by the offsetParent property.

offsetParent

Retrieves a reference to the container object that defines the offsetTop and offsetLeft properties of the object.

offsetTop

Retrieves the calculated top position of the object relative to the layout or coordinate parent, as specified by the offsetParent property.

offsetWidth

Retrieves the width of the object relative to the layout or coordinate parent, as specified by the offsetParent property.

outerHTML

Sets or retrieves the object and its content in HTML.

outerText

Sets or retrieves the text of the object.

ownerDocument

Retrieves the document object associated with the node.

parentElement

Retrieves the parent object in the object hierarchy.

parentNode

Retrieves the parent object in the document hierarchy.

parentTextEdit

Retrieves the container object in the document hierarchy that can be used to create a TextRange containing the original object.

prefix

Retrieves the local name of the fully qualified XML declaration for a node.

previousElementSibling

Retrieves a reference to the immediately preceding sibling element or NULL if the element does not have any preceding siblings.

previousSibling

Gets a reference to the previous child of the parent for the object.

readyState

Retrieves the current state of the object.

readyState

Retrieves a value that indicates the current state of the object.

role

Sets or retrieves the role for this element.

sandbox

Read-only

Enables security restrictions for iframe elements that contain potentially untrusted content.

sourceIndex

Retrieves the ordinal position of the object, in source order, as the object appears in the document's all collection.

src

Sets or retrieves a URL to be loaded by the object.

style

Sets an inline style for the element.

tabIndex

Sets or retrieves the index that defines the tab order for the object.

tagName

Retrieves the tag name of the object.

textContent

Sets or retrieves the text content of an object and any child objects.

title

Sets or retrieves advisory information (a ToolTip) for the object.

uniqueID

Retrieves an autogenerated, unique identifier for the object.

uniqueNumber

Retrieves the element's unique number.

width

Sets or retrieves the width of the object.

x-ms-format-detection

Determines whether data formats within content are automatically detected and (if found) converted to clickable links.

 

Standards information

Remarks

The iframe element functions as a document within a document, or like a floating frame. The frames collection provides access to the contents of an iframe. Use the frames collection to read or write to elements contained in an iframe. For example, the syntax for accessing the backgroundColor style of the body object in an iframe is:


sColor = document.frames("sFrameName").document.body.style.backgroundColor;

You can access the iframe object's properties, but not its contents, through the object model of the page where the iframe object resides. For example, the syntax for accessing the border style of the iframe object is:


sBorderValue = document.all.oFrame.style.border;

Note  Properties of the iframe must be accessed using the prefix, document.all, for example, document.all.iframeId.marginWidth.

Examples

This example uses the iframe element and an HTML fragment to create a frame containing the page sample.htm.


<iframe id="IFrame1" frameborder="0" scrolling="no" src="sample.htm"></iframe>

This example returns a reference to the all collection of the document contained by the iframe.


var collAll = document.frames("IFrame1").document.all

See also

Using IFRAME Elements

 

 

Show:
© 2014 Microsoft. All rights reserved.