IHTMLFrameSetElement

IHTMLFrameSetElement


This interface specifies a frameset. Framesets are used to organize multiple frames and nested framesets. A frameset organizes multiple frames on the screen. Only FRAME, nested FRAMESET, and the NOFRAMES tags are valid within a frameset.

This element is a block element.

IHTMLFrameSetElement Methods
put_rows   get_rows   put_cols  
get_cols   put_border   get_border  
put_borderColor   get_borderColor   put_frameBorder  
get_frameBorder   put_frameSpacing   get_frameSpacing  
put_name   get_name   put_onload  
get_onload   put_onunload   get_onunload  
put_onbeforeunload   get_onbeforeunload  

IHTMLFrameSetElement::put_rows

HRESULT put_rows(
    BSTR v
);

Specifies a comma-delimited list of frames to create. Each item in the list contains the initial size of the row.

v
String specifying a comma-delimited list of frames.

See also get_rows

IHTMLFrameSetElement::get_rows

HRESULT get_rows(
    BSTR *p
);

Retrieves a comma-delimited list of frames to create. Each item in the list contains the initial size of the row.

p
Address of a variable that receives the comma-delimited list.

See also put_rows

IHTMLFrameSetElement::put_cols

HRESULT put_cols(
    BSTR v
);

Specifies a comma-delimited list of frames to create. Each item in the list contains the initial size of the column.

v
String specifying a comma-delimited list of frames.

See also get_cols

IHTMLFrameSetElement::get_cols

HRESULT get_cols(
    BSTR *p
);

Retrieves a comma-delimited list of frames to create. Each item in the list contains the initial size of the column.

p
Address of a variable that receives the comma-delimited list.

See also put_cols

IHTMLFrameSetElement::put_border

HRESULT put_border(
    VARIANT v
);

Sets the border color and must be used with the border property, except for frames.

v
String or value specifying the color. It can be one of the color names or values given in the Color Table reference documentation.

See also get_border

IHTMLFrameSetElement::get_border

HRESULT get_border(
    VARIANT *p
);

Retrieves the border color and must be used with the border property, except for frames.

v
Addres of a variable that receives a string or value specifying the color. It can be one of the color names or values given in the Color Table reference documentation.

See also put_border

IHTMLFrameSetElement::put_borderColor

HRESULT put_borderColor(
    VARIANT v
);

Sets the border color.

v
String or value specifying the color. The color can be one of the color names or values given in the Color Table reference documentation.

See also get_borderColor

IHTMLFrameSetElement::get_borderColor

HRESULT get_borderColor(
    VARIANT *p
);

Retrieves the border color.

p
Address of a variable that receives the color. The color can be one of the color names or values given in the Color Table reference documentation.

See also put_borderColor

IHTMLFrameSetElement::put_frameBorder

HRESULT put_frameBorder(
    BSTR v
);

Specifies whether to display a border for the frame.

v
String specifying whether to display a border. If this parameter is "Yes", the frame will have an inset border. If it is "No", the frame will have no border. Any other value turns on the borders.

See also get_frameBorder

IHTMLFrameSetElement::get_frameBorder

HRESULT get_frameBorder(
    BSTR *p
);

Determines whether a border is currently being displayed for the frame.

p
Address of a variable that receives "Yes" if the frame has an inset border, or "No" if it has no border.

See also put_frameBorder

IHTMLFrameSetElement::put_frameSpacing

HRESULT put_frameSpacing(
    VARIANT v
);

Creates additional space between the frames, in pixels.

v
String or value specifying the amount of additional space. The default spacing is 2 pixels.

The amount defined for frameSpacing does not include the width of the frameBorder. frameSpacing can be set on one or more FRAMESETs, and applies to the contained FRAMESET unless the contained FRAMESET defines a different frameSpacing.

See also get_frameSpacing

IHTMLFrameSetElement::get_frameSpacing

HRESULT get_frameSpacing(
    VARIANT *p
);

Retrieves the amount of additional space between the frames, in pixels.

p
Address of a variable that receives the amount of additional space. The default spacing is 2 pixels.

The amount defined for frameSpacing does not include the width of the frameBorder. frameSpacing can be set on one or more FRAMESETs, and applies to the contained FRAMESET unless the contained FRAMESET defines a different frameSpacing.

See also put_frameSpacing

IHTMLFrameSetElement::put_name

HRESULT put_name(
    BSTR v
);

Sets the name of the frame so it can be targeted from links in other documents.

v
String specifying the name. It can be the name of a window or frame, or one of the following values:
window_name String that specifies a frame.
_blank Loads the link into a new, unnamed window.
_parent Loads the link over the parent. If the frame has no parent, this refers to _self.
_self Replaces the page with the specified link.
_top Loads the link at the topmost level.

The name property on the window comes from the FRAME definition. There is no other way to persist a window name in HTML.

See also get_name

IHTMLFrameSetElement::get_name

HRESULT get_name(
    BSTR *p
);

Retrieves the name of the frame so it can be targeted from links in other documents.

p
Address of a variable that receives the window or frame name, or one of these values:
window_name String that specifies a frame.
_blank Loads the link into a new, unnamed window.
_parent Loads the link over the parent. If the frame has no parent, this refers to _self.
_self Replaces the page with the specified link.
_top Loads the link at the topmost level.

The name property on the window comes from the FRAME definition. There is no other way to persist a window name in HTML.

See also put_name

IHTMLFrameSetElement::put_onload

HRESULT put_onload(
    VARIANT v
);

Sets the inline script associated with the onload event before a FRAME element is loaded.

v
VARIANT structure that contains the script to be set.

See also get_onload

ITMLFrameSetElement::get_onload

HRESULT get_onload(
    VARIANT *p
);

Retrieves the inline script associated with the onload event before a FRAME element is loaded.

p
Address of a VARIANT structure that receives the script.

See also put_onload

IHTMLFrameSetElement::put_onunload

HRESULT put_onunload(
    VARIANT v
);

Sets the inline script associated with the onunload event before a FRAME element is unloaded.

v
VARIANT structure that contains the script to be set.

See also get_onunload

IHTMLFrameSetElement::get_onunload

HRESULT get_onunload(
    VARIANT *p
);

Retrieves the inline script associated with the onunload event before a FRAME element is unloaded.

p
Address of a VARIANT structure that receives the script.

See also put_onunload

IHTMLFrameSetElement::put_onbeforeunload

HRESULT put_onbeforeunload(
    VARIANT v
);

Sets the inline script associated with the onbeforeunload event before a FRAME element is unloaded.

v
VARIANT structure that contains the script to be set.

This event is fired before the onunload event. It provides an opportunity to warn the user if the window is currently in an unsaved state and the information will be lost.

See also get_onbeforeunload

IHTMLFrameSetElement::get_onbeforeunload

HRESULT get_onbeforeunload(
    VARIANT *p
);

Retrieves the inline script associated with the onbeforeunload event before a FRAME element is unloaded.

p
Address of a VARIANT structure that receives the script.

This event is fired before the onunload event. It provides an opportunity to warn the user if the window is currently in an unsaved state and the information will be lost.

See also put_onbeforeunload

© 1997 Microsoft Corporation. All rights reserved. Terms of Use.