IHTMLMarqueeElement

IHTMLMarqueeElement


This interface is used to specify a MARQUEE element. The MARQUEE tag enables you to create a scrolling text marquee, and control its content.

IHTMLMarqueeElement Methods
put_bgColor   get_bgColor   put_scrollDelay  
get_scrollDelay   put_direction   get_direction  
put_behavior   get_behavior   put_scrollAmount  
get_scrollAmount   put_loop   get_loop  
put_vspace   get_vspace   put_hspace  
get_hspace   put_onfinish   get_onfinish  
put_onstart   get_onstart   put_onbounce  
get_onbounce   put_width   get_width  
put_height   get_height   put_trueSpeed  
get_trueSpeed   start   stop  

IHTMLMarqueeElement::put_bgColor

HRESULT put_bgColor(
    VARIANT v 
);

Sets the background color behind the element.

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

See also get_bgColor

IHTMLMarqueeElement::get_bgColor

HRESULT get_bgColor(
    VARIANT *p 
);

Retrieves the background color behind the element.

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

See also put_bgColor

IHTMLMarqueeElement::put_scrollDelay

HRESULT put_scrollDelay(
    long v 
);

Sets the speed at which the MARQUEE scrolls.

v
Value specifying the scroll delay, in milliseconds.

See also get_scrollDelay

IHTMLMarqueeElement::get_scrollDelay

HRESULT get_scrollDelay(
    long *p 
);

Retrieves the speed at which the MARQUEE scrolls.

p
Address of a variable that receives the scroll delay, in milliseconds.

See also put_scrollDelay

IHTMLMarqueeElement::put_direction

HRESULT put_direction(
    BSTR v 
);

Sets the direction in which the text scrolls.

v
String specifying the scroll direction. Can be one of these values:
down The marquee scrolls down.
left The marquee scrolls left. This is the default value.
right The marquee scrolls right.
up The marquee scrolls up.

See also get_direction

IHTMLMarqueeElement::get_direction

HRESULT get_direction( 
    BSTR *p 
);

Retrieves the current direction in which the text scrolls.

p
Address of a variable that receives the scroll direction. Can be one of these values:
down The marquee scrolls down.
left The marquee scrolls left. This is the default value.
right The marquee scrolls right.
up The marquee scrolls up.

See also put_direction

IHTMLMarqueeElement::put_behavior

HRESULT put_behavior(
    BSTR v 
);

Sets how the text scrolls in the MARQUEE.

v
String specifying the scrolling behavior. Can be one of these values:
alternate The marquee alternates left and right.
scroll The marquee is a scrolling marquee in the direction specified by the direction attribute. The text scrolls off the end and starts over.
slide The marquee is a scrolling marquee in the direction specified by the direction attribute. The text scrolls to the end and stops.

See also get_behavior

IHTMLMarqueeElement::get_behavior

HRESULT get_behavior(
    BSTR *p 
);

Retrieves how the text scrolls in the marquee.

p
Address of a variable that receives one of these strings:
alternate The marquee alternates left and right.
scroll The marquee is a scrolling marquee in the direction specified by the direction attribute. The text scrolls off the end and starts over.
slide The marquee is a scrolling marquee in the direction specified by the direction attribute. The text scrolls to the end and stops.

See also put_behavior

IHTMLMarqueeElement::put_scrollAmount

HRESULT put_scrollAmount(
    long v 
);

Sets the number of pixels the text scrolls between each subsequent drawing of the MARQUEE.

v
Value specifying the number of pixels.

See also get_scrollAmount

IHTMLMarqueeElement::get_scrollAmount

HRESULT get_scrollAmount( 
    long *p 
);

Retrieves the number of pixels the text scrolls between each subsequent drawing of the MARQUEE.

p
Address of a variable that receives the number of pixels.

See also put_scrollAmount

IHTMLMarqueeElement::put_loop

HRESULT put_loop(
    long v 
);

Sets the number of times the MARQUEE should loop.

v
Value specifying the number of times to loop. If this parameter is -1 (infinite), the marquee will loop continuously.

Below are descriptions on how loop works for some boundary cases.
<BGSOUND src="file:///c:\win95\system\msremind.wav"> once
<BGSOUND src="file:///c:\win95\system\msremind.wav" LOOP> once
<BGSOUND src="file:///c:\win95\system\msremind.wav" LOOP=> zero times
<BGSOUND src="file:///c:\win95\system\msremind.wav" LOOP=-1> infinitely
<BGSOUND src="file:///c:\win95\system\msremind.wav" LOOP=0> once

See also get_loop

IHTMLMarqueeElement::get_loop

HRESULT get_loop(
    long *p 
);

Retrieves the number of times the MARQUEE will loop.

p
Address of a variable that receives the number of times to loop. This parameter receives -1 if the marquee is set to loop continuously.

Below are descriptions on how loop works for some boundary cases.
<BGSOUND src="file:///c:\win95\system\msremind.wav"> once
<BGSOUND src="file:///c:\win95\system\msremind.wav" LOOP> once
<BGSOUND src="file:///c:\win95\system\msremind.wav" LOOP=> zero times
<BGSOUND src="file:///c:\win95\system\msremind.wav" LOOP=-1> infinitely
<BGSOUND src="file:///c:\win95\system\msremind.wav" LOOP=0> once

See also put_loop

IHTMLMarqueeElement::put_vspace

HRESULT put_vspace(
    long v 
);

Sets the vertical margins for the element.

v
Value specifying the margins.

Similar to border, except the margins are not painted with color when the element is a link.

See also get_vspace

IHTMLMarqueeElement::get_vspace

HRESULT get_vspace(
    long *p 
);

Retrieves the vertical margins for the element.

p
Address of a variable that receives the vertical margins.

Similar to border, except the margins are not painted with color when the element is a link.

See also put_vspace

IHTMLMarqueeElement::put_hspace

HRESULT put_hspace(
    long v 
);

Sets the horizontal margins for the element.

v
Value specifying the horizontal margins.

Similar to border, except the margins are not painted with color when the element is a link.

See also get_hspace

IHTMLMarqueeElement::get_hspace

HRESULT get_hspace( 
    long *p 
);

Retrieves the horizontal margins for the element.

p
Address of a variable that receives the horizontal margins.

Similar to border, except the margins are not painted with color when the element is a link.

See also put_hspace

IHTMLMarqueeElement::put_onfinish

HRESULT put_onfinish(
    VARIANT v 
);

Sets the inline script associated with the onfinish event on the MARQUEE element. This event is fired when the looping is complete.

v
VARIANT structure that contains the script to be set.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also get_onfinish

IHTMLMarqueeElement::get_onfinish

HRESULT get_onfinish(
    VARIANT *p 
);

Retrieves the inline script associated with the onfinish event on the MARQUEE element. This event is fired when the looping is complete.

p
Address of a VARIANT structure that contains the script.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also put_onfinish

IHTMLMarqueeElement::put_onstart

HRESULT put_onstart(
    VARIANT v 
);

Sets the inline script associated with the onstart event on the MARQUEE element. This event is fired when a loop begins, and when a bounce cycle begins for alternate behavior.

v
VARIANT structure that contains the script to be set.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also get_onstart

IHTMLMarqueeElement::get_onstart

HRESULT get_onstart(
    VARIANT *p 
);

Retrieves the inline script associated with the onstart event on the MARQUEE element. This event is fired when a loop begins, and when a bounce cycle begins for alternate behavior.

p
Address of a VARIANT structure that contains the script.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also put_onstart

IHTMLMarqueeElement::put_onbounce

HRESULT put_onbounce(
    VARIANT v 
);

Sets the inline script associated with the onbounce event on the MARQUEE element. This event is fired when the behavior property of the MARQUEE element is set to "alternate", and the content of the marquee reaches the specified side.

v
VARIANT structure that contains the script to be set.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also get_onbounce

IHTMLMarqueeElement::get_onbounce

HRESULT get_onbounce(
    VARIANT *p 
);

Retrieves the inline script associated with the onbounce event on the MARQUEE element. This event is fired when the behavior property of the MARQUEE element is set to "alternate", and the content of the marquee reaches the specified side.

p
Address of a VARIANT structure that contains the script to be set.

For more information on inline script, see Attaching an Event Handler in the Understanding the Event Model documentation.

See also put_onbounce

IHTMLMarqueeElement::put_width

HRESULT put_width(
    VARIANT v 
);

Sets the calculated width of the element, in pixels.

v
Value specifying the width.

This property is an integer value. Although an HTML author can specify the width as a percentage, this property always specifies the width in pixels.

See also get_width

IHTMLMarqueeElement::get_width

HRESULT get_width(
    VARIANT *p 
);

Retrieves the calculated width of the element, in pixels.

p
Address of a variable that receives the width.

This read-only property is an integer value. Although an HTML author can specify the width as a percentage, this property always specifies the width in pixels.

See also put_width

IHTMLMarqueeElement::put_height

HRESULT put_height(
    VARIANT v 
);

Sets the calculated height of the element, in pixels.

v
Value specifying the height.

If the value of the corresponding HTML attribute was set using a percentage, this property specifies the height in pixels represented by that percentage.

See also get_height

IHTMLMarqueeElement::get_height

HRESULT get_height(
    VARIANT *p 
);

Retrieves the calculated height of the element, in pixels.

p
Address of a variable that receives the height.

If the value of the corresponding HTML attribute was set using a percentage, this property specifies the height in pixels represented by that percentage.

See also put_height

IHTMLMarqueeElement::put_trueSpeed

HRESULT put_trueSpeed(
    VARIANT_BOOL v 
);

Sets whether the position of the marquee is calculated using the scrollDelay and scrollAmount properties, and the actual time elapsed from the last clock tick.

v
Boolean value that has one of the following meanings:
TRUE The marquee advances the pixel value of scrollAmount per the number of milliseconds (ms) set for scrollDelay. For example, the marquee advances 10 pixels for every 6ms if scrollDelay is 6 and scrollAmount is 10.
FALSE The marquee computes movement based on 60ms ticks of the clock. This means every scrollDelay value under 60 is essentially ignored, and the marquee advances the amount of scrollAmount each 60ms. For example, if scrollDelay is 6 and scrollAmount is 10, the marquee advances 10 pixels every 60ms.

By default, this property is FALSE.

See also get_trueSpeed

IHTMLMarqueeElement::get_trueSpeed

HRESULT get_trueSpeed(
    VARIANT_BOOL *p 
);

Retrieves whether the position of the marquee is calculated using the scrollDelay and scrollAmount properties, and the actual time elapsed from the last clock tick.

v
Address of a boolean value that has one of the following meanings:
TRUE The marquee advances the pixel value of scrollAmount per the number of milliseconds (ms) set for scrollDelay. For example, the marquee advances 10 pixels for every 6ms if scrollDelay is 6 and scrollAmount is 10.
FALSE The marquee computes movement based on 60ms ticks of the clock. This means every scrollDelay value under 60 is essentially ignored, and the marquee advances the amount of scrollAmount each 60ms. For example, if scrollDelay is 6 and scrollAmount is 10, the marquee advances 10 pixels every 60ms.

By default, this property is FALSE.

See also put_trueSpeed

IHTMLMarqueeElement::start

HRESULT start(
    void 
);

Begins scrolling the marquee.

See also stop

IHTMLMarqueeElement::stop

HRESULT stop(
    void 
);

Stops scrolling the marquee.

See also start

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