Microsoft Developer Network

Creates inline floating frames.

Members Table

The following table lists the members exposed by the iframe object.

Attributes/Properties

Show: Attributes/Properties Behaviors Collections Events Filters Methods Objects Styles

Attribute Property Description ALIGN align Sets or retrieves a value that indicates the table alignment. ALLOWTRANSPARENCY allowTransparency Sets or retrieves whether the object can be transparent. APPLICATION Indicates whether the content of the object is an HTML Application (HTA), which is exempt from the browser security model. ariaBusy   Sets or retrieves the busy state of this element. ariaChecked   Sets or retrieves the checked state of this element. ariaDisabled   Sets or retrieves the disabled state of this element. ariaExpanded   Sets or retrieves the expanded state of this element. ariaHaspopup   Sets or retrieves a value indicating whether this element may display a pop-up window. ariaHidden   Sets or retrieves the hidden state of this element. ariaInvalid   Sets or retrieves the invalid state of this element. ariaLevel   Sets or retrieves the level of this element. ariaMultiselect   Sets or retrieves the multiple-selection state of this element. ariaPosinset   Sets or retrieves the current position of an item within a set. ariaPressed   Sets or retrieves the pressed state of a button that can be toggled. ariaReadonly   Sets or retrieves the read-only state of this element. ariaRequired   Sets or retrieves the form-completion requirement of this element. ariaSecret   Sets or retrieves the secret state of this element. ariaSelected   Sets or retrieves the selection state of this element. ariaSetsize   Sets or retrieves the set size of this element. 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 border 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 Sets or retrieves the value indicating whether the object can contain rich HTML markup. CLASS className Sets or retrieves the class of the object. contentDocument   Retrieves the document object of the page or frame. contentWindow Retrieves the window object of the specified frame or iframe. DATAFLD dataFld Sets or gets which field of a given data source, as specified by the dataSrc property, to bind to the specified object. DATASRC dataSrc Sets or gets the source of the data for data binding. firstChild Retrieves a reference to the first child in the childNodes collection of the object. FRAMEBORDER frameBorder Sets or retrieves whether to display a border for the frame. HEIGHT height Sets or retrieves the height of the object. HIDEFOCUS hideFocus Sets or gets the value that indicates whether the object visibly shows that it has focus. HSPACE hspace Sets or retrieves the horizontal margin for the object. ID id Retrieves the string identifying 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 lang Sets or retrieves the language to use. LANGUAGE language Sets or retrieves the language in which the current script is written. lastChild Retrieves a reference to the last child in the childNodes collection of an object. longDesc Sets or retrieves a Uniform Resource Identifier (URI) to a long description of the object. MARGINHEIGHT marginHeight Sets or retrieves the top and bottom margin heights before displaying the text in a frame. MARGINWIDTH marginWidth Sets or retrieves the left and right margin widths before displaying the text in a frame. NAME name Sets or retrieves the frame name. nextSibling Retrieves a reference to the next child of the parent for the object. nodeName Retrieves the name of a particular type of node. nodeType Retrieves the type of the requested node. nodeValue Sets or retrieves the value of a node. 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. onOffBehavior Gets an object that indicates whether the specified Microsoft DirectAnimation behavior is running. 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. previousSibling Retrieves 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. recordNumber Retrieves the ordinal record from the data set that generated the object. role   Sets or retrieves the role for this element. scopeName Gets the namespace defined for the element. SCROLLING scrolling Sets or retrieves whether the frame can be scrolled. SECURITY Sets the value indicating whether the source file of a frame or iframe has specific security restrictions applied. sourceIndex Retrieves the ordinal position of the object, in source order, as the object appears in the document's all collection. SRC src Sets or retrieves a URL to be loaded by the object. STYLE Sets an inline style for the element. TABINDEX tabIndex Sets or retrieves the index that defines the tab order for the object. tagName Retrieves the tag name of the object. tagUrn Sets or gets the Uniform Resource Name (URN) specified in the namespace declaration. TITLE title Sets or retrieves advisory information (a ToolTip) for the object. uniqueID Retrieves an autogenerated, unique identifier for the object. UNSELECTABLE Specifies that an element cannot be selected. VSPACE vspace Sets or retrieves the vertical margin for the object. WIDTH width Sets or retrieves the width of the object. Behavior Description clientCaps Provides information about features supported by Internet Explorer, as well as a way for installing browser components on demand. download Downloads a file and notifies a specified callback function when the download is complete. homePage Contains information about a user's homepage. time Provides an active timeline for an HTML element. time2 Provides an active timeline for an HTML element or group of elements. Collection Description all Returns a reference to the collection of elements contained by the object. attributes Retrieves a collection of attributes of the object. behaviorUrns Returns a collection of Uniform Resource Name (URN) strings identifying the behaviors attached to the element. childNodes Retrieves a collection of HTML Elements and TextNode objects that are direct descendants of the specified object. children Retrieves a collection of DHTML Objects that are direct descendants of the object. Event Description onactivate Fires when the object is set as the active element. onafterupdate Fires on a databound object after successfully updating the associated data in the data source object. onbeforedeactivate Fires immediately before the activeElement is changed from the current object to another object in the parent document. onbeforeupdate Fires on a databound object before updating the associated data in the data source object. onblur Fires when the object loses the input focus. oncontrolselect Fires when the user is about to make a control selection of the object. ondeactivate Fires when the activeElement is changed from the current object to another object in the parent document. onerrorupdate Fires on a databound object when an error occurs while updating the associated data in the data source object. onfocus Fires when the object receives focus. onload Fires immediately after the browser loads the object. onmove Fires when the object moves. onmoveend Fires when the object stops moving. onmovestart Fires when the object starts to move. onreadystatechange Fires when the state of the object has changed. onresizeend Fires when the user finishes changing the dimensions of the object in a control selection. onresizestart Fires when the user begins to change the dimensions of the object in a control selection. ontimeerror Fires whenever a time-specific error occurs, usually as a result of setting a property to an invalid value. Filter property Description Alpha Adjusts the opacity of the content of the object. AlphaImageLoader Displays an image within the boundaries of the object and between the object background and content, with options to clip or resize the image. When loading a Portable Network Graphics (PNG) image, tranparency—from zero to 100 percent—is supported. Barn Reveals new content of the object with a motion that resembles doors opening or closing. BasicImage Adjusts the color processing, image rotation, or opacity of the content of the object. BlendTrans Reveals new content of the object by fading the original content. Blinds Reveals new content of the object with a motion that appears to open or close blinds. Blur Blurs the content of the object so that it appears out of focus. CheckerBoard Reveals new content of the object by uncovering squares placed like a checkerboard over the original content. Chroma Displays a specific color of the content of the object as transparent. Compositor Displays new content of the object as a logical color combination of the new and original content. The color and alpha values of each version of the content are evaluated to determine the final color on the output image. DropShadow Creates a solid silhouette of the content of the object, offset in the specified direction. This creates the illusion that the content is floating and casting a shadow. Emboss Displays the content of the object as an embossed texture using grayscale values. Engrave Displays the content of the object as an engraved texture using grayscale values. Fade Reveals new content of the object by fading out the original content. FlipH Displays the content of the object flipped across the horizontal axis. FlipV Displays the content of the object flipped across the vertical axis. Glow Adds radiance around the outside edges of the content of the object so that it appears to glow. Gradient Displays a colored surface between the object's background and content. GradientWipe Reveals new content of the object by passing a gradient band over the original content. Gray Displays the content of the object in grayscale. ICMFilter Converts the color content of the object based on an Image Color Management (ICM) profile. This enables improved display of specific content, or simulated display for hardware devices, such as printers or monitors. Inset Reveals new content of the object diagonally. Invert Reverses the hue, saturation, and brightness values of the content of the object. Iris Reveals new content of the object with an iris effect, similar to the opening of a camera aperture. Light Creates the effect of a light shining on the content of the object. MaskFilter Displays transparent pixels of the object content as a color mask, and makes the nontransparent pixels transparent. Matrix Resizes, rotates, or reverses the content of the object using matrix transformation. MotionBlur Causes the content of the object to appear to be in motion. Pixelate Displays the content of the object as colored squares that take the average color value of the pixels they replace. This filtered display can be used as a transition. RadialWipe Reveals new content of the object with a radial wipe, like a windshield-wiper blade. RandomBars Reveals new content of the object by exposing random lines of pixels. RandomDissolve Reveals new content of the object by exposing random pixels. Redirect Not currently supported. RevealTrans Reveals new content of the object using one of 24 predefined Transition effects. Shadow Creates a solid silhouette of the content of the object, offset in the specified direction. This creates the illusion of a shadow. Slide Reveals new content of the object by sliding sections of the image into place. Spiral Reveals new content of the object with a spiral motion. Stretch Reveals new content of the object with a stretching motion to cover the original content. One option resembles a cube rotating from one face to another. Strips Reveals new content of the object by moving successive strips into place, like a diagonal saw blade passing across the original content. Wave Performs a sine wave distortion of the content of the object along the vertical axis. Wheel Reveals new content of the object with a rotating motion, like spokes of a wheel covering the original content. Xray Changes the color depth of the content of the object and displays it in black and white. Zigzag Reveals new content of the object with a forward and back motion that moves down the object. Method Description addBehavior Attaches a behavior to the element. appendChild Appends an element as a child to the object. applyElement Makes the element either a child or parent of another element. attachEvent Binds the specified function to an event, so that the function gets called whenever the event fires on the object. blur Causes the element to lose focus and fires the onblur event. clearAttributes Removes all attributes and values from the object. cloneNode Copies a reference to the object from the document hierarchy. componentFromPoint Returns the component located at the specified coordinates via certain events. contains Checks whether the given element is contained within the object. detachEvent Unbinds the specified function from the event, so that the function stops receiving notifications when the event fires. dragDrop Initiates a drag event. fireEvent Fires a specified event on the object. 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. getAttribute Retrieves the value of the specified attribute. getAttributeNode Gets an attribute object referenced by the attribute.name property. getElementsByTagName Retrieves a collection of objects based on the specified element name. getExpression Retrieves the expression for the given property. hasAttribute   Determines whether an attribute with the specified name exists. 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. mergeAttributes Copies all read/write attributes to the specified element. normalize Merges adjacent TextNode objects to produce a normalized document object model. removeAttribute   Removes the given attribute from the object. removeAttribute Removes the given attribute from the object. removeAttributeNode Removes an attribute object from the object. removeBehavior Detaches a behavior from the element. removeChild Removes a child node from the object. removeExpression Removes the expression from the specified property. 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. setAttribute Sets the value of the specified attribute. setAttributeNode Sets an attribute object node as part of the object. setExpression Sets an expression for the specified object. swapNode Exchanges the location of two objects in the document hierarchy. Object Description runtimeStyle Represents the cascaded format and style of the object that overrides the format and style specified in global style sheets, inline styles, and HTML attributes. style Represents the current settings of all possible inline styles for a given element. Style attribute Style property Description ACCELERATOR accelerator Sets or retrieves a string that indicates whether the object contains an accelerator key. background-attachment backgroundAttachment Sets or retrieves how the background image is attached to the object within the document. background-color backgroundColor Sets or retrieves the color behind the content of the object. background-position-x backgroundPositionX Sets or retrieves the x-coordinate of the backgroundPosition property. background-position-y backgroundPositionY Sets or retrieves the y-coordinate of the backgroundPosition property. behavior behavior Sets or retrieves the location of the Dynamic HTML (DHTML) behavior. border-bottom borderBottom Sets or retrieves the properties of the bottom border of the object. border-bottom-color borderBottomColor Sets or retrieves the color of the bottom border of the object. border-bottom-style borderBottomStyle Sets or retrieves the style of the bottom border of the object. border-bottom-width borderBottomWidth Sets or retrieves the width of the bottom border of the object. border-color borderColor Sets or retrieves the border color of the object. border-left borderLeft Sets or retrieves the properties of the left border of the object. border-left-color borderLeftColor Sets or retrieves the color of the left border of the object. border-left-style borderLeftStyle Sets or retrieves the style of the left border of the object. border-left-width borderLeftWidth Sets or retrieves the width of the left border of the object. border-right borderRight Sets or retrieves the properties of the right border of the object. border-right-color borderRightColor Sets or retrieves the color of the right border of the object. border-right-style borderRightStyle Sets or retrieves the style of the right border of the object. border-right-width borderRightWidth Sets or retrieves the width of the right border of the object. border-style borderStyle Sets or retrieves the style of the left, right, top, and bottom borders of the object. border-top borderTop Sets or retrieves the properties of the top border of the object. border-top-color borderTopColor Sets or retrieves the color of the top border of the object. border-top-style borderTopStyle Sets or retrieves the style of the top border of the object. border-top-width borderTopWidth Sets or retrieves the width of the top border of the object. border-width borderWidth Sets or retrieves the width of the left, right, top, and bottom borders of the object. bottom bottom Sets or retrieves the bottom position of the object in relation to the bottom of the next positioned object in the document hierarchy. clear clear Sets or retrieves whether the object allows floating objects on its left side, right side, or both, so that the next text displays past the floating objects. clip clip Sets or retrieves which part of a positioned object is visible. cursor cursor Sets or retrieves the type of cursor to display as the mouse pointer moves over the object. display display Sets or retrieves whether the object is rendered. filter filter Sets or retrieves the filter or collection of filters applied to the object. height height Sets or retrieves the height of the object. layout-grid layoutGrid Sets or retrieves the composite document grid properties that specify the layout of text characters. layout-grid-mode layoutGridMode Sets or retrieves whether the text layout grid uses two dimensions. left left Sets or retrieves the position of the object relative to the left edge of the next positioned object in the document hierarchy. margin margin Sets or retrieves the width of the top, right, bottom, and left margins of the object. margin-bottom marginBottom Sets or retrieves the height of the bottom margin of the object. margin-left marginLeft Sets or retrieves the width of the left margin of the object. margin-right marginRight Sets or retrieves the width of the right margin of the object. margin-top marginTop Sets or retrieves the height of the top margin of the object. max-height maxHeight Sets or retrieves the maximum height for an element. min-height minHeight Sets or retrieves the minimum height for an element. outline   outline Sets or retrieves the color, style, and width of the outline frame. outline-color   outlineColor Sets or retrieves the color of the outline frame. outline-style   outlineStyle Sets or retrieves the style of the outline frame. outline-width   outlineWidth Sets or retrieves the width of the outline frame. overflow-x overflowX Sets or retrieves how to manage the content of the object when the content exceeds the width of the object. overflow-y overflowY Sets or retrieves how to manage the content of the object when the content exceeds the height of the object. pixelBottom Sets or retrieves the bottom position of the object. pixelHeight Sets or retrieves the height of the object. pixelLeft Sets or retrieves the left position of the object. pixelRight Sets or retrieves the right position of the object. pixelTop Sets or retrieves the top position of the object. pixelWidth Sets or retrieves the width of the object. posBottom Sets or retrieves the bottom position of the object in the units specified by the bottom attribute. posHeight Sets or retrieves the height of the object in the units specified by the height attribute. position position Sets or retrieves the type of positioning used for the object. posLeft Sets or retrieves the left position of the object in the units specified by the left attribute. posRight Sets or retrieves the right position of the object in the units specified by the right attribute. posTop Sets or retrieves the top position of the object in the units specified by the top attribute. posWidth Sets or retrieves the width of the object in the units specified by the width attribute. right right Sets or retrieves the position of the object relative to the right edge of the next positioned object in the document hierarchy. float styleFloat Sets or retrieves on which side of the object the text will flow. text-autospace textAutospace Sets or retrieves the autospacing and narrow space width adjustment of text. top top Sets or retrieves the position of the object relative to the top of the next positioned object in the document hierarchy. visibility visibility Sets or retrieves whether the content of the object is displayed. z-index zIndex Sets or retrieves the stacking order of positioned objects. zoom zoom Sets or retrieves the magnification scale of the object.

Remarks

Security Alert   To protect user privacy and safeguard your applications, Internet Explorer restricts some interactions between frames that host Web pages from different domains. To treat the content of the iframe as if it were in the Restricted Sites zone, set the SECURITY attribute to "restricted." For more information about using the DHTML object model with the frame and iframe objects, see About Cross-Frame Scripting and Security and Security Considerations: Dynamic HTML.

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.

Microsoft Internet Explorer 5.5 supports transparent content with inline floating frames. The following conditions must be met to define transparent content for inline floating frames.

1. The ALLOWTRANSPARENCY attribute, used with the IFRAME element, must be set to true.
2. In the IFRAME content source document, the background-color attribute of the BODY element must be set to transparent.

See Using Transparency with Inline Floating Frames for more information on transparent floating frames.

This element is a block element.

This element requires a closing tag.

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

Standards Information

This object is defined in HTML 4.0  and is defined in World Wide Web Consortium (W3C) Document Object Model (DOM) Level 1 .

See Also

Using IFRAME Elements