This topic has not yet been rated - Rate this topic

ITextHost::TxCreateCaret method

Creates a new shape for windowless rich edit control's caret.

Syntax


BOOL TxCreateCaret(
  [in]  HBITMAP hbmp,
  [in]  INT xWidth,
  [in]  INT yHeight
);

Parameters

hbmp [in]

Type: HBITMAP

Handle to the bitmap for the new caret shape.

If the windowless rich edit control has the SES_LOGICALCARET style, hbmp is a combination of the following values:

ValueMeaning
CARET_CUSTOM

An adorned caret. This value is valid only if CARET_RTL is also specified.

CARET_ITALIC

An italicized caret.

CARET_NONE

A blinking vertical bar.

CARET_NULL

An empty bitmap (for non-degenerate text selection).

CARET_ROTATE90

A caret that is rotated clockwise by 90 degrees.

CARET_RTL

The caret moves right to left.

 

xWidth [in]

Type: INT

Caret width, in logical units.

yHeight [in]

Type: INT

Caret height, in logical units.

Return value

Type: BOOL

Return TRUE if the method succeeds.

Return FALSE if the method fails.

Remarks

This method is only valid when the control is in-place active; calls while the control is inactive may fail.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Textserv.h

DLL

Msftedit.dll

See also

ITextHost
Conceptual
Windowless Rich Edit Controls
Other Resources
CreateCaret

 

 

Send comments about this topic to Microsoft

Build date: 10/27/2012

Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.