Frame and frameset functions

Frame and frameset functions handle two tasks: getting the names of the frames in a frameset and splitting a frame in two.

dom.getFrameNames()

Availability

Dreamweaver 3.

Description

Gets a list of all the named frames in the frameset.

Arguments

None.

Returns

An array of strings where each string is the name of a frame in the current frameset. Any unnamed frames are skipped. If none of the frames in the frameset is named, an empty array returns.

Example

For a document that contains four frames (two of which are named), a call to the dom.getFrameNames() function might return an array that contains the following strings:

• "navframe"

• "main_content"

dom.isDocumentInFrame()

Availability

Dreamweaver 4.

Description

Identifies whether the current document is being viewed inside a frameset.

Arguments

None.

Returns

A Boolean value: TRue if the document is in a frameset; false otherwise.

dom.saveAllFrames()

Availability

Dreamweaver 4.

Description

If a document is a frameset or is inside a frameset, this function saves all the frames and framesets from the Document window. If the specified document is not in a frameset, this function saves the document. This function opens the Save As dialog box for any documents that have not been previously saved.

Arguments

None.

Returns

Nothing.

dom.splitFrame()

Availability

Dreamweaver 3.

Description

Splits the selected frame vertically or horizontally.

Arguments

 splitDirection 

• The splitDirection argument is a string that must specify one of the following directions: "up", "down", "left", or "right".

Returns

Nothing.

Enabler

See "dom.canSplitFrame()" on page 1066.