IHTMLFrameBase

IHTMLFrameBase


This interface provides access to properties and methods that are common to FRAME and IFRAME elements.

IHTMLFrameBase Methods
put_src   get_src   put_name  
get_name   put_border   get_border  
put_frameBorder   get_frameBorder   put_frameSpacing  
get_frameSpacing   put_marginWidth   get_marginWidth  
put_marginHeight   get_marginHeight   put_noResize  
get_noResize   put_scrolling   get_scrolling  

IHTMLFrameBase::put_src

HRESULT put_src(
    BSTR v
);

Sets the URL of the associated file.

v
String specifying the URL.

See also get_src

IHTMLFrameBase::get_src

HRESULT get_src(
    BSTR *p
);

Retrieves the URL of the associated file.

p
Address of a variable that receives the URL.

See also put_src

IHTMLFrameBase::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

IHTMLFrameBase::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

IHTMLFrameBase::put_border

HRESULT put_border(
    VARIANT v
);

Specifies the thickness of the border.

v
String or value specifying the thickness.

Setting a border to zero or omitting the attribute causes no border to be displayed. Supplying the border attribute without a value defaults to a single border.

See also get_border

IHTMLFrameBase::get_border

HRESULT get_border(
    VARIANT *p
);

Retrieves the thickness of the border.

p
Address of a variable that receives the thickness.

Setting a border to zero or omitting the attribute causes no border to be displayed. Supplying the border attribute without a value defaults to a single border.

See also put_border

IHTMLFrameBase::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

IHTMLFrameBase::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

IHTMLFrameBase::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

IHTMLFrameBase::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

IHTMLFrameBase::put_marginWidth

HRESULT put_marginWidth(
    VARIANT v
);

Sets the width, in pixels, of the left and right margins for the text in a frame.

v
String or value specifying margin widths.

Margins cannot be less than 1 nor too large that the text cannot be displayed.

See also get_marginWidth

IHTMLFrameBase::get_marginWidth

HRESULT get_marginWidth(
    VARIANT *p
);

Retrieves the width, in pixels, of the left and right margins for the text in a frame.

p
Address of a variable that receives the width.

Margins cannot be less than 1 nor so large that the text cannot be displayed.

See also put_marginWidth

IHTMLFrameBase::put_marginHeight

HRESULT put_marginHeight(
    VARIANT v
);

Sets the width, in pixels, of the top and bottom margins for the text in a frame.

v
String or value specifying margin widths.

Margins cannot be less than 1 nor so large that the text cannot be displayed.

See also get_marginHeight

IHTMLFrameBase::get_marginHeight

HRESULT get_marginHeight(
    VARIANT *p
);

Retrieves the width, in pixels, of the top and bottom margins for the text in a frame.

p
Address of a variable that receives the width.

Margins cannot be less than 1 nor so large that the text cannot be displayed.

See also put_marginHeight

IHTMLFrameBase::put_noResize

HRESULT put_noResize(
    VARIANT_BOOL v
);

Specifies whether the user can resize the frame.

v
Resize flag. TRUE means the size is fixed; the user cannot resize the frame. FALSE means the user can resize the frame. This is the default value for the property.

See also get_noResize

IHTMLFrameBase::get_noResize

HRESULT get_noResize(
    VARIANT_BOOL *p
);

Retrieves whether the user can resize the frame.

p
Address of a variable that receives TRUE if the frame is not resizeable, or FALSE if it is.

See also put_noResize

IHTMLFrameBase::put_scrolling

HRESULT put_scrolling(
    BSTR v
);

Specifies whether the frame can be scrolled.

v
String specifying one of these values:
auto The browser determines if the scroll bars are necessary. This is the default value.
no The frame cannot be scrolled.
yes The frame can be scrolled.

See also get_scrolling

IHTMLFrameBase::get_scrolling

HRESULT get_scrolling(
    BSTR *p 
);

Retrieves a value indicating whether the frame can be scrolled.

p
Address of a variable that receives one of these values:
auto The browser determines if the scroll bars are necessary. This is the default value.
no The frame cannot be scrolled.
yes The frame can be scrolled.

See also put_scrolling

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