ITextHost::TxSetCursor method (textserv.h)

Article
10/13/2021

Establishes a new cursor shape (I-beam) in the text host's window.

Syntax

void TxSetCursor(
  [in] HCURSOR hcur,
  [in] BOOL    fText
);

Parameters

[in] hcur

Type: HCURSOR

Handle to the cursor.

[in] fText

Type: BOOL

If TRUE, indicates the caller is trying to set the text cursor. See the Remarks section for more information.

Return value

None

Remarks

This method may be called at any time, whether the control is active or inactive.

TxSetCursor should be called by the text services object to set the mouse cursor. If the fText parameter is TRUE, the text services object is trying to set the text cursor (the cursor appears as an I-beam when it is over text that is not selected). In this case, the host can set it to whatever the control MousePointer property is. This is required for Microsoft Visual Basic compatibility since, through the MousePointer property, the Visual Basic programmer has control over the shape of the mouse cursor.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	textserv.h
DLL	Msftedit.dll