Skip to content

Latest commit

 

History

History
91 lines (66 loc) · 3.54 KB

nf-uiautomationclient-iuiautomationtextpattern2-getcaretrange.md

File metadata and controls

91 lines (66 loc) · 3.54 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:uiautomationclient.IUIAutomationTextPattern2.GetCaretRange
IUIAutomationTextPattern2::GetCaretRange (uiautomationclient.h)
Retrieves a zero-length text range at the location of the caret that belongs to the text-based control.
GetCaretRange
GetCaretRange method [Windows Accessibility]
GetCaretRange method [Windows Accessibility]
IUIAutomationTextPattern2 interface
IUIAutomationTextPattern2 interface [Windows Accessibility]
GetCaretRange method
IUIAutomationTextPattern2.GetCaretRange
IUIAutomationTextPattern2::GetCaretRange
uiautomationclient/IUIAutomationTextPattern2::GetCaretRange
winauto.uiauto_IUIAutomationTextPattern2_GetCaretRange
winauto\uiauto_IUIAutomationTextPattern2_GetCaretRange.htm
WinAuto
EDB53C04-142E-4DCC-8DD7-F7DD4BC6A67F
12/05/2018
GetCaretRange, GetCaretRange method [Windows Accessibility], GetCaretRange method [Windows Accessibility],IUIAutomationTextPattern2 interface, IUIAutomationTextPattern2 interface [Windows Accessibility],GetCaretRange method, IUIAutomationTextPattern2.GetCaretRange, IUIAutomationTextPattern2::GetCaretRange, uiautomationclient/IUIAutomationTextPattern2::GetCaretRange, winauto.uiauto_IUIAutomationTextPattern2_GetCaretRange
uiautomationclient.h
UIAutomation.h
Windows
Windows 8 [desktop apps only]
Windows Server 2012 [desktop apps only]
UIAutomationClient.idl
Windows
19H1
IUIAutomationTextPattern2::GetCaretRange
uiautomationclient/IUIAutomationTextPattern2::GetCaretRange
c++
APIRef
kbSyntax
COM
UIAutomationClient.h
IUIAutomationTextPattern2.GetCaretRange

IUIAutomationTextPattern2::GetCaretRange

-description

Retrieves a zero-length text range at the location of the caret that belongs to the text-based control.

-parameters

-param isActive [out, retval]

Type: BOOL*

TRUE if the text-based control that contains the caret has keyboard focus, otherwise FALSE.

-param range [out, retval]

Type: IUIAutomationTextRange**

Receives a text range that represents the current location of the caret that belongs to the text-based control.

-returns

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

-remarks

If the isActive parameter is FALSE, the caret that belongs to the text-based control might not be at the same location as the system caret.

This method retrieves a text range that a client can use to find the bounding rectangle of the caret belonging to the text-based control, or to find the text near the caret.

-see-also

IUIAutomationTextPattern2

UI Automation Support for Textual Content

Working with Text-based Controls