ITextProvider2::GetCaretRange-Methode (uiautomationcore.h)

  • Artikel

Stellt einen Textbereich der Länge null an der Position des Carets bereit, das zum textbasierten Steuerelement gehört.

Syntax

HRESULT GetCaretRange(
  [out]         BOOL               *isActive,
  [out, retval] ITextRangeProvider **pRetVal
);

Parameter

[out] isActive

Typ: BOOL*

TRUE , wenn das textbasierte Steuerelement, das den Caret enthält, den Tastaturfokus hat, andernfalls FALSE.

[out, retval] pRetVal

Typ: ITextRangeProvider**

Ein Textbereich, der die aktuelle Position des Carets darstellt, das zum textbasierten Steuerelement gehört.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Wenn der parameter isActiveFALSE ist, befindet sich das Caret, das zum textbasierten Steuerelement gehört, möglicherweise nicht an der gleichen Position wie das System caret.

Diese Methode ruft einen Textbereich ab, den ein Client verwenden kann, um das umgebende Rechteck des Carets zu finden, das zum textbasierten Steuerelement gehört, oder um den Text in der Nähe des Carets zu suchen.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 8 [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2012 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile uiautomationcore.h (include UIAutomation.h)

Weitere Informationen

ITextProvider2