scrollIntoView method

  • Article

[This documentation is preliminary and is subject to change.]

Causes the object to scroll into view, aligning it either at the top or bottom of the window.

Syntax

HRESULT retVal = object.scrollIntoView(varargStart);

Standards information

There are no standards that apply here.

Parameters

varargStart [in, optional]

Type: VARIANT

VARIANT of type VT_BOOL that specifies one of the following values:

TRUE (true)

Default. Scrolls the object so that top of the object is visible at the top of the window.

FALSE (false)

Scrolls the object so that the bottom of the object is visible at the bottom of the window.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The scrollIntoView method is useful for immediately showing the user the result of some action without requiring the user to manually scroll through the document to find the result.

Depending on the size of the given object and the current window, this method might not be able to put the item at the very top or very bottom, but will position the object as close to the requested position as possible.

 

 

Build date: 6/12/2012