In order to access this site you need to enable JavaScript!

You are here: Reference > JavaScript > client-side > HTML DOM > objects > nodes and tags > frame

frame object

Browser support:

Specifies a nameable window region.

The frame element allows authors to insert more than one HTML document into a browser window. It must be within a frameset element. Using frames can prevent search engines from finding the contents within pages, so it is not recommended to use the frameset and frame elements (because of the indexing mechanism of search robots).

Syntax:

Properties that reference the object:

•	window.frameElement

Methods that return the object:

•	document.createElement ("frame")

The base interface, through which you can add new functionalities to the frame object, is the HTMLFrameElement interface.

If you want to see the HTML objects by categories, please visit this page.

HTML page for this element: frame

Possible members:

Properties

Methods

Events

Style properties

allowTransparency


9

Sets or retrieves whether a frame element (frame or iframe) can be transparent.

attributes

Represents a collection of attribute nodes that belong to an element.

baseURI

			10

Returns the base URL for the object.

behaviorUrns

Represents a collection of the Uniform Resource Names for all behaviors attached to an element.

borderColor

Sets or retrieves the color of the border.

canHaveChildren

Retrieves a Boolean value that indicates whether the element can contain child elements.

canHaveHTML

Retrieves a Boolean value that indicates whether the element can contain HTML formatted text.

className

Sets or retrieves the style class or classes that belong to the element.

clientHeight

Returns the height of the visible area for an object, in pixels. The value contains the height with the padding, but it does not include the scrollBar, border, and the margin.

clientLeft

Returns the width of the left border in pixels.

clientTop

Returns the height of the top border in pixels.

clientWidth

Returns the width of the visible area for an object, in pixels. The value contains the width with the padding, but does not include the scrollBar, border, and the margin.

contentDocument

8

Retrieves the document generated by a frame or iframe element.

contentEditable

	3

Sets or retrieves whether the contents of the object are editable.

contentWindow

Retrieves the window generated by a frame or iframe element.

currentStyle

Represents the computed style settings for an element.

dataFld

Specifies or returns which field of a given data source should be bound to the specified object.

dataFormatAs

Specifies or returns how data is to be rendered.

dataSrc

Sets or retrieves the identifier of the data source that is bound to the element.

filters

Represents a collection of all filter objects applied to an element.

frameBorder

Sets or retrieves whether the frame is surrounded by a 3-D border.

height

Specifies or returns the height of an element.

Sets or retrieves a unique identifier for the object.

isContentEditable

Returns a Boolean value that indicates whether the contents of the object are editable by the user.

isDisabled

Returns a Boolean value that indicates whether the object is disabled.

isMultiLine

Returns a Boolean value that indicates whether the contents of an element can be multiline or not.

isTextEdit

Returns a Boolean value that indicates whether the createTextRange method can be used for the element.

language

Sets or retrieves the scripting language for the current element. Use it only for the script element.

localName

9

Returns the local part of the qualified name of the current node.

longDesc

Specifies or retrieves the URI (Uniform Resource Identifier) of the long description of a frame, iframe or img element.

marginHeight

Sets or retrieves the top and bottom margins for a frame element.

marginWidth

Sets or retrieves the left and right margins for a frame element.

name

Sets or retrieves the initial name of the contained window.

namespaceURI

9	3.6

Sets or returns the namespace URI of the current node.

nextElementSibling

9	3.5

Returns a reference to the next child element of the current element's parent.

nextSibling

Returns a reference to the next child of the current element's parent.

nodeName

Returns the name of the current node.

nodeType

Returns an integer that indicates the type of the node.

nodeValue

Sets or returns the value of the current node.

noResize

Specifies or returns whether a frame window is resizable.

offsetHeight

Returns the height of the visible area for an object, in pixels. The value contains the height with the padding, scrollBar, and the border, but does not include the margin.

offsetLeft

Returns the left position of an object relative to the left side of its offsetParent element, in pixels.

offsetParent

Returns a reference to the closest ancestor element in the DOM hierarchy from which the position of the current element is calculated.

offsetTop

Returns the top position of the object relative to the top side of its offsetParent element, in pixels.

offsetWidth

Returns the width of the visible area for an object, in pixels. The value contains the width with the padding, scrollBar, and the border, but does not include the margin.

outerHTML

Sets or retrieves the outer HTML content (the source code including the opening and closing tags) of an element.

outerText

Sets or returns the text content of an element including the text content of its descendants.

ownerDocument

Returns the document object that contains the current node.

parentElement

Returns the parent element of the object in the DOM hierarchy.

parentNode

Returns the parent element of the current node in the DOM hierarchy.

parentTextEdit

Returns the closest ancestor element of the current element in the DOM hierarchy that can be used to create a TextRange object.

previousElementSibling

9	3.5

Returns a reference to the previous child element of the current element's parent.

previousSibling

Returns a reference to the previous node of the current element's parent.

readyState

Returns a string value that represents the state of the object.

recordNumber

Returns an integer value that indicates the ordinal position of the item within the data set that generated the current object.

runtimeStyle

Represents the overridden style settings for an element.

scopeName

Retrieves the local name of the namespace declared for the current element.

scrolling

Sets or retrieves whether a frame has scrollbars.

sourceIndex

Returns the position of the current object in the all collection of the document.

src

Sets or retrieves the location of an associated file for an object.

style

Represents the inline style settings for an element or a CSS rule.

tabIndex

Specifies or returns the tabbing order for keyboard navigation using the TAB key.

tagName

Returns the tag name of the current element.

tagUrn

Sets or retrieves the Uniform Resource Name (URN) of the namespace declared for the current element.

title

Specifies or returns a tooltip for an element.

uniqueID

Returns the unique identifier generated by the browser for the object.

unselectable

Sets or retrieves whether the selection process can start in an element's content.

width

Specifies or returns the default width of the element.

addBehavior

Attaches the specified behavior to the current element.

addEventListener

9

Registers an event handler function (event listener) for the specified event on the current object.

applyElement

Inserts the specified element as a child or parent of the current element.

attachEvent

Registers an event handler function (event listener) for the specified event on the current object.

blur

Removes the focus from the current element, and fires the onblur event.

clearAttributes

Clears all attributes from the current element, except the id, name, style, value and event attributes.

click

Simulates a mouse click on the current element.

cloneNode

Returns an exact copy of the current node.

compareDocumentPosition

9

Compares the placement of the specified node with the current node in the DOM hierarchy.

componentFromPoint

Returns the region of the current element that is located at the specified coordinates.

detachEvent

Removes the specified event handler from the current element that was registered earlier with the attachEvent method.

dispatchEvent

9

Dispatches the specified event to the current element.

dragDrop

Initiates a drag-and-drop operation.

fireEvent

Initializes an event object and dispatches it to the current element.

focus

Sets the focus on the current element.

getAdjacentText

Returns the contents of the TextNode located at the specified position relative to the current element.

getAttribute

Returns the value of the attribute with the specified name from the current element.

getAttributeNode

Returns the attribute node with the specified name from the current element.

getAttributeNodeNS

9

Returns the attribute node with the specified namespace and name from the current element.

getAttributeNS

9

Returns the value of the attribute with the specified namespace and name from the current element.

getBoundingClientRect

	3	9.5	4

Returns a TextRectangle object that specifies the bounding rectangle of the current element or TextRange object, in pixels, relative to the upper-left corner of the browser's client area.

getClientRects

	3	9.5	4

Retrieves a TextRectangles collection that specifies the exact shape of the current element or TextRange object.

getExpression


9

Returns the dynamic expression for the specified DHTML property on the current element.

hasAttribute

8

Returns whether the current element has an attribute with the specified name or not.

hasAttributeNS

9

Returns whether the current element has an attribute with the specified namespace and name or not.

hasAttributes

8

Returns whether the current element has any attributes specified or not.

hasChildNodes

Returns whether the current node has any child nodes or not.

insertAdjacentElement

Inserts an element at the specified position relative to the current element.

insertAdjacentHTML

Inserts a HTML formatted text at the specified position relative to the current element.

insertAdjacentText

Creates a new TextNode from the specified text and inserts it at the specified position relative to the current element.

isDefaultNamespace

9

Returns whether the specified namespace URI is the default namespace in the scope of the current node.

isEqualNode

9

Returns whether the current node is equal to the specified one.

isSameNode

9

Returns whether the current node is the same node as the specified one.

isSupported

9

Returns whether the specified DOM module and version is supported by the current node.

mergeAttributes

Copies all attributes and its values from the specified element to the current element.

normalize

Puts the subtree that belongs to the current node into a 'normalized' form.

releaseCapture

Releases the mouse capture from the browser window that was previously set by the setCapture method and restores the normal event processing.

removeAttribute

Removes the attribute with the specified name from the current element.

removeAttributeNode

Removes the specified attribute node from the current element.

removeAttributeNS

9

Removes the attribute with the specified namespace and name from the current element.

removeBehavior

Removes the specified behavior from the current element.

removeEventListener

9

Removes the specified event handler from the current element that was registered earlier with the addEventListener method.

removeExpression


9

Removes the dynamic expression from the specified DHTML property on the current element.

removeNode

Removes the current element with or without its children from the document tree.

replaceAdjacentText

Replace the contents of the TextNode located at the specified position relative to the current element with the specified text.

replaceNode

Replaces the current element with the specified element.

scrollIntoView

Scrolls the specified element into the visible area of the document.

setActive

Sets the element as the active element in the current document.

setAttribute

Adds an attribute with the specified name and value to the current element.

setAttributeNode

Adds the specified attribute node to the current element.

setAttributeNodeNS

9

Adds the specified attribute node to the current element.

setAttributeNS

9

Adds an attribute with the specified namespace, name and value to the current element.

setCapture

Sets the current object to capture mouse events that occur within the entire browser window.

setExpression


9

Sets a dynamic expression for the specified DHTML property on the current element.

swapNode

Interchanges the positions of the current element and the specified element in the document hierarchy.

onactivate

Occurs when an element becomes active.

onafterupdate

Occurs on a databound object after it updates the data in the data source object.

onbeforeactivate

Occurs before an element becomes active.

onbeforedeactivate

Occurs on the active element before it loses the active state.

onbeforeupdate

Occurs on a databound object before it updates the data in the data source object.

onblur

Occurs when an element loses focus.

oncontrolselect

Occurs before a control is selected in an editable region.

ondeactivate

Occurs on the active element when it loses the active state.

onerrorupdate

Occurs on a databound object when it cannot update the data in the data source object.

onfilterchange

Occurs after a filter has changed or finished a transition.

onfocus

Occurs when an element receives focus.

onfocusin

Occurs before an element receives focus.

onfocusout

Occurs after an element loses focus.

onload

Occurs when an object has been loaded.

onmouseenter

Occurs when the user moves the mouse pointer into the area of an element.

onmouseleave

Occurs when the user moves the mouse pointer out of the element.

onmouseout

Occurs when the user moves the mouse pointer out of the element.

onmouseover

Occurs when the user moves the mouse pointer into the element.

onmove

Occurs when the position of an element's top-left corner is changed.

onmoveend

Occurs when the user stops dragging an absolute or relative positioned element in an editable region.

onmovestart

Occurs when the user starts dragging an absolute or relative positioned element in an editable region.

onpropertychange

Occurs every time when the value of an element's property is changed.

onreadystatechange

Occurs when the load state of the data that belongs to an element or a HTML document changes.

onresize

Occurs when the size of an object has changed.

onresizeend

Occurs when the user stops resizing an element in an editable region.

onresizestart

Occurs when the user starts to resize an element in an editable region.

background

Specifies or returns up to five separate background properties, in a shorthand form.

backgroundAttachment

Specifies or returns whether the backgroundImage should scroll with the contents of the object or not.

backgroundColor

Specifies or returns the color to use for the background of the object.

backgroundImage

Specifies or returns the image to use as the background of the object.

backgroundPosition

Sets or retrieves the position of the backgroundImage within the element.

backgroundRepeat

Specifies or returns how to tile the backgroundImage relative to the upper-left corner of the container object.

behavior

Sets or retrieves the URL of a behavior file.

border

Sets or retrieves up to three separate border properties, in a shorthand form.

borderBottom

Sets or retrieves the color, style and width properties for the element's bottom border, in a shorthand form.

borderBottomColor

Specifies or returns the color of the element's bottom border.

borderBottomStyle

Specifies or returns the style of the element's bottom border.

borderBottomWidth

Specifies or returns the width of the element's bottom border.

borderColor

Specifies or returns the color of the element's border.

borderLeft

Specifies or returns the color, style and width properties for the element's left border, in a shorthand form.

borderLeftColor

Specifies or returns the color of the element's left border.

borderLeftStyle

Specifies or returns the style of the element's left border.

borderLeftWidth

Specifies or returns the width of the element's left border.

borderRight

Specifies or returns the color, style and width properties for the element's right border, in a shorthand form.

borderRightColor

Specifies or returns the color of the element's right border.

borderRightStyle

Specifies or returns the style of the element's right border.

borderRightWidth

Specifies or returns the width of the element's right border.

borderStyle

Specifies or returns the style of the element's border.

borderTop

Specifies or returns the color, style and width properties for the element's top border, in a shorthand form.

borderTopColor

Specifies or returns the color of the element's top border.

borderTopStyle

Specifies or returns the style of the element's top border.

borderTopWidth

Specifies or returns the width of the element's top border.

borderWidth

Specifies or returns the width of the element's border.

cssText

Sets or retrieves the contents of a style declaration as a string.

display

Specifies or returns the element's display type.

filter

Specifies or returns the filter or collection of filters applied to the object.

hasLayout

Returns a Boolean value that indicates whether the object has layout or not.

layoutGrid

Specifies or returns up to four separate layout-grid properties that specify the layout of text characters.

layoutGridMode

Specifies or returns whether the text layout grid uses one or two dimensions.

length

9

Returns the number of properties that have been set in the current style object.

padding

Specifies or returns a shorthand property for setting the top, right, bottom and left spaces between an element's border and its contents, in that order.

paddingBottom

Specifies or returns the space between an element's bottom border and its contents.

paddingLeft

Specifies or returns the space between an element's left border and its contents.

paddingRight

Specifies or returns the space between an element's right border and its contents.

paddingTop

Specifies or returns the space between an element's top border and its contents.

pixelBottom

Specifies or retrieves the value of the bottom style property, in pixels.

pixelHeight

Specifies or retrieves the value of the height style property, in pixels.

pixelLeft

Specifies or retrieves the value of the left style property, in pixels.

pixelRight

Specifies or retrieves the value of the right style property, in pixels.

pixelTop

Specifies or retrieves the value of the top style property, in pixels.

pixelWidth

Specifies or retrieves the value of the width style property, in pixels.

posBottom

Specifies or retrieves the value of the bottom style property as a floating-point number that specifies the value in the current unit type of the bottom property.

posHeight

Specifies or retrieves the value of the height style property as a floating-point number that specifies the value in the current unit type of the height property.

posLeft

Specifies or retrieves the value of the left style property as a floating-point number that specifies the value in the current unit type of the left property.

posRight

Specifies or retrieves the value of the right style property as a floating-point number that specifies the value in the current unit type of the right property.

posTop

Specifies or retrieves the value of the top style property as a floating-point number that specifies the value in the current unit type of the top property.

posWidth

Specifies or retrieves the value of the width style property as a floating-point number that specifies the value in the current unit type of the width property.

visibility

Specifies or returns whether the element is visible.

zoom

Specifies or returns the zoom level of the element's content.

Example HTML code 1:

This example illustrates the use of the frame element:

Code

topFrame.htm

mainFrame.htm

<frameset rows="110,*" cols="*" border="10px">
    <frame src="topFrame.htm" name="topFrame" scrolling="No"/>
    <frame src="mainFrame.htm" name="mainFrame"/>
</frameset>

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
</head>
<body>
    <h1>Contents of the top frame</h1>
    May contain menu items or a logo.
</body>
</html>

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <script type="text/javascript">
        function AddRow (statTable, element, attr, attrValue) {
            if (attrValue == null)
                attrValue = element.getAttribute (attr);

            var row = document.createElement ("tr");
            var nameCell = document.createElement ("td");
            var valueCell = document.createElement ("td");
            nameCell.innerHTML = attr;
            valueCell.innerHTML = attrValue;

            row.appendChild (nameCell);
            row.appendChild (valueCell);
            statTable.appendChild (row);
        }

        function CreateFramesetStat () {
            var statTable = document.getElementById ("frameset_stat");
            var frameSet = window.frameElement.parentNode;

            AddRow (statTable, frameSet, "border");
            AddRow (statTable, frameSet, "borderColor");
            AddRow (statTable, frameSet, "frameBorder");
            AddRow (statTable, frameSet, "frameSpacing");
            AddRow (statTable, frameSet, "cols");
            AddRow (statTable, frameSet, "rows");
        }

        function CreateTopFrameStat () {
            var statTable = document.getElementById ("topframe_stat");
            var frame = parent.frames['topFrame'].frameElement;

            AddRow (statTable, frame, "noResize", frame.noResize);
            AddRow (statTable, frame, "scrolling");
        }

        function CreateMainFrameStat () {
            var statTable = document.getElementById ("mainframe_stat");
            var frame = window.frameElement;

            AddRow (statTable, frame, "noResize", frame.noResize);
            AddRow (statTable, frame, "scrolling");
        }

        function CreateStat () {
            CreateFramesetStat ();
            CreateTopFrameStat ();
            CreateMainFrameStat ();
        }

    </script>
</head>
<body onload="CreateStat ()">
    <table> 
        <thead>
            <tr>
                <th>Frameset</th>
                <th>Top frame</th>
                <th>Main frame</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td valign="top">
                    <table border="1px" cellspacing="2px">
                        <thead>
                            <tr>
                                <th>name</th>
                                <th>value</th>
                            </tr>
                        </thead>
                        <tbody id="frameset_stat">
                        </tbody>
                    </table>
                </td>
                <td valign="top">
                    <table border="1px" cellspacing="2px">
                        <thead>
                            <tr>
                                <th>name</th>
                                <th>value</th>
                            </tr>
                        </thead>
                        <tbody id="topframe_stat">
                        </tbody>
                    </table>
                </td>
                <td valign="top">
                    <table border="1px" cellspacing="2px">
                        <thead>
                            <tr>
                                <th>name</th>
                                <th>value</th>
                            </tr>
                        </thead>
                        <tbody id="mainframe_stat">
                        </tbody>
                    </table>
                </td>
            </tr>
        </tbody>
    </table>
</body>
</html>

Copy Code

Preview

Syntax Highlighter

Did you find this example helpful? yes no

frameset

External links:

frame element (MSDN)
frame element (Safari Reference Library)
frame element (W3C)

Digg Del.icio.us Reddit Facebook Twitter Diigo

User Contributed Comments

frame object

Syntax:

Possible members:

Example HTML code 1:

Related pages:

External links:

Post Content