Help Center

CTextDocument2.GetClientRectmethod

Retrieves the client rectangle of the rich edit control.

Windowsmethoddoc-orphan
No implementation located. This member is documented, but the source scan found no matching declaration. It is likely declared in a header this scan does not resolve, or provided by a macro.

Syntax

FUNCTION GetClientRect (BYVAL nType AS LONG, BYVAL pLeft AS LONG PTR, BYVAL pTop AS LONG PTR, BYVAL pRight AS LONG PTR, BYVAL pBottom AS LONG PTR) AS HRESULT

Parameters

NameDescription
nTypeThe client rectangle retrieval options. It can be a combination of the following values.
tomClientCoord. Retrieve the rectangle in client coordinates. If this value isn't specified, the function retrieves screen coordinates.
tomIncludeInset. Add left and top insets to the left and top coordinates of the client rectangle, and subtract right and bottom insets from the right and bottom coordinates.
tomTransform. Use a world transform (XFORM) provided by the host application to transform the retrieved rectangle coordinates.
pLeftThe x-coordinate of the upper-left corner of the rectangle.
pTopThe y-coordinate of the upper-left corner of the rectangle.
pRightThe x-coordinate of the lower-right corner of the rectangle.
pBottomThe y-coordinate of the lower-right corner of the rectangle.

Return value

If the method succeeds, GetLastResult returns NOERROR. Otherwise, it returns an HRESULT error code.

Description

Retrieves the client rectangle of the rich edit control.

Reference