ITextHost::TxGetClientRect method

Retrieves the client coordinates of the text host's client area.

Syntax


HRESULT TxGetClientRect(
   LPRECT prc
);

Parameters

prc

Type: LPRECT

The client coordinates of the text host's client area.

Return value

Type: HRESULT

Return S_OK if the method succeeds.

Return the following COM error code if the method fails. For more information on COM error codes, see Error Handling in COM.

Return codeDescription
E_FAIL

Unspecified error.

 

Remarks

The client rectangle is the rectangle that the text services object is responsible for painting and managing. The host relies on the text services object for painting that area. And, the text services object must not paint or invalidate areas outside of that rectangle.

The host forwards mouse messages to the text services object when the cursor is over the client rectangle.

The client rectangle is expressed in client coordinates of the containing window.

Important  The ITextHost::TxGetClientRect method will fail if called at an inactive time.
 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Textserv.h

DLL

Msftedit.dll

See also

ITextHost
Conceptual
Windowless Rich Edit Controls
Other Resources
RECT

 

 

Show: