IHTMLElement2::getBoundingClientRect Method

Retrieves a reference to a rectangle object that bounds a collection of TextRectangle objects.

Syntax

HRESULT getBoundingClientRect(
    IHTMLRect **pRect
    );

Parameters

pRect
Address of a pointer to an IHTMLRect interface that returns a rectangle object.

Return Value

Returns S_OK if the function was bound successfully, or an error code otherwise.

Remarks

The pRect parameter has properties such as top, left, right, and bottom. Each property represents a coordinate of the rectangle, in pixels.

The getBoundingClientRect method retrieves the left, top, right, or bottom coordinate of the union of rectangles relative to the client window's upper-left corner. In Microsoft® Internet Explorer 5, the window's upper-left is at 2,2 (pixels) with respect to the true client.