frameset element | frameSet object

This element is obsolete and should no longer be used. Use iframe or CSS instead. Specifies a frameset, which is used to organize multiple frames and nested framesets.

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

HTML information

Closing Tagrequired
CSS Displayinline

Members

The frameSet object has these types of members:

Events

The frameSet object has these events.

EventDescription
abort

Fires when the user aborts the download.

activate

Fires when the object is set as the active element.

afterprint

Fires on the object immediately after its associated document prints or previews for printing.

afterupdate

Fires on a databound object after successfully updating the associated data in the data source object.

beforecopy

Fires on the source object before the selection is copied to the system clipboard.

beforeprint

Fires on the object before its associated document prints or previews for printing.

beforeunload

Fires prior to a document being unloaded.

beforeupdate

Fires on a databound object before updating the associated data in the data source object.

blur

Fires when the object loses the input focus.

cellchange

Fires when data changes in the data provider.

change

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

controlselect

Fires when the user is about to make a control selection of the object.

dataavailable

Fires periodically as data arrives from data source objects that asynchronously transmit their data.

datasetchanged

Fires when the data set exposed by a data source object changes.

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.

errorupdate

Fires on a databound object when an error occurs while updating the associated data in the data source object.

filterchange

Fires when a visual filter changes state or completes a transition.

focus

Fires when the object receives focus.

hashchange

Raised when there are changes to the portion of a URL that follows the number sign (#).

This event is not supported for Windows Store apps using JavaScript.

input

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

layoutcomplete

Fires when the print or print preview layout process finishes filling the current LayoutRect object with content from the source document.

load

Fires immediately after the client loads the object.

message

Fires when the user sends a cross-document message or a message is sent from a Worker with postMessage.

move

Fires when the object moves.

moveend

Fires when the object stops moving.

movestart

Fires when the object starts to move.

offline

Raised when Internet Explorer is working offline.

This event is not supported for Windows Store apps using JavaScript.

onbeforedeactivate

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

ondatasetcomplete

Fires to indicate that all data is available from the data source object.

online

Raised when Internet Explorer is working online.

This event is not supported for Windows Store apps using JavaScript.

onselect

Fires when the current selection changes.

reset

Fires when the user resets a form.

resize

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

resizeend

Fires when the user finishes changing the dimensions of the object in a control selection.

resizestart

Fires when the user begins to change the dimensions of the object in a control selection.

rowenter

Fires to indicate that the current row has changed in the data source and new data values are available on the object.

rowexit

Fires just before the data source control changes the current row in the object.

rowsdelete

Fires when rows are about to be deleted from the recordset.

rowsinserted

Fires just after new rows are inserted in the current recordset.

scroll

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

storage

Fires when a Web Storage area is updated.

unload

Fires immediately before the object is unloaded.

 

Methods

The frameSet object has these methods.

MethodDescription
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

Note   attachEvent is no longer supported. Starting with IE11, use addEventListener. For info, see Compatibility changes.

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.

click

Simulates a click by causing the onclick event to fire.

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.

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.

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.

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.

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.

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.

removeBehavior

Detaches a behavior from the element.

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.

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.

setCapture

Sets the mouse capture to the object that belongs to the current document.

swapNode

Exchanges the location of two objects in the document hierarchy.

 

Properties

The frameSet object has these properties.

PropertyDescription

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.

borderColor

Sets or retrieves the border color of the object.

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.

cols

Sets or retrieves the frame widths of the object.

This property is not supported for Windows Store apps using JavaScript.

constructor

Returns a reference to the constructor of an object.

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.

frameBorder

Sets or retrieves whether to display a border for the frame.

frameSpacing

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

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.

language

Sets or retrieves the language in which the current script is written.

Note  This has been superceded by the type attribute for the script element. If you are using javascript alone, you don't need to specify a type or language with the script element.

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.

name

Sets or retrieves the frame name.

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.

offsetHeight

Retrieves the height 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.

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.

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.

recordNumber

Retrieves the ordinal record from the data set that generated the object.

role

Sets or retrieves the role for this element.

rows

Sets or retrieves the frame heights of the object.

scopeName

Gets the namespace defined for the element.

This property is not supported for Windows Store apps using JavaScript.

sourceIndex

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

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 URN specified in the namespace declaration.

This property is not supported for Windows Store apps using JavaScript.

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.

 

Standards information

Remarks

The frameset element is a container for the frame element. An HTML document can contain either the frameset element or the body element, but not both.

If a user opens a folder inside a frame and then clicks something in the folder, the file or folder that the user clicks takes over the entire window. For example, suppose that a page contains two frames, one frame pointing to http://www.microsoft.com and the second frame pointing to a network drive. If the user clicks a file or folder in the second frame, that frame takes control of the entire window, including the first frame. For file types that the application cannot host, such as .txt files, a separate window in the appropriate host application is opened.

A folder is a part of the file system hierarchy, but it does not necessarily represent anything in the file system. An example is Network Neighborhood.

Security Warning:   To protect user privacy and safeguard your applications, Windows Internet Explorer restricts some interactions between frames that host Web pages from different domains. For more information about using the Dynamic HTML (DHTML) object model with the frame and iframe objects, see About Cross-Frame Scripting and Security and Security Considerations: Dynamic HTML.

Examples

This example uses the frameset element to define three columns of rectangular frames in a document.


<frameset cols="25%, 50%, *">
<frame src="contents.htm">
<frame src="info.htm">
<frame scrolling="no" src="graphic.htm">
</frameset>

See also

frame

 

 

Show:
© 2014 Microsoft