Skip to content

Latest commit

 

History

History
100 lines (70 loc) · 3.94 KB

nf-textserv-itexthost-txgetacceleratorpos.md

File metadata and controls

100 lines (70 loc) · 3.94 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:textserv.ITextHost.TxGetAcceleratorPos
ITextHost::TxGetAcceleratorPos (textserv.h)
Requests the special character to use for the underlining accelerator character.
ITextHost interface [Windows Controls]
TxGetAcceleratorPos method
ITextHost.TxGetAcceleratorPos
ITextHost::TxGetAcceleratorPos
TxGetAcceleratorPos
TxGetAcceleratorPos method [Windows Controls]
TxGetAcceleratorPos method [Windows Controls]
ITextHost interface
_win32_ITextHost_TxGetAcceleratorPos
_win32_ITextHost_TxGetAcceleratorPos_cpp
controls.ITextHost_TxGetAcceleratorPos
controls._win32_ITextHost_TxGetAcceleratorPos
textserv/ITextHost::TxGetAcceleratorPos
controls\ITextHost_TxGetAcceleratorPos.htm
Controls
VS|Controls|~\controls\richedit\windowlessricheditcontrols\windowlessricheditcontrolsreference\windowlessricheditcontrolinterfaces\txgetacceleratorpos.htm
12/05/2018
ITextHost interface [Windows Controls],TxGetAcceleratorPos method, ITextHost.TxGetAcceleratorPos, ITextHost::TxGetAcceleratorPos, TxGetAcceleratorPos, TxGetAcceleratorPos method [Windows Controls], TxGetAcceleratorPos method [Windows Controls],ITextHost interface, _win32_ITextHost_TxGetAcceleratorPos, _win32_ITextHost_TxGetAcceleratorPos_cpp, controls.ITextHost_TxGetAcceleratorPos, controls._win32_ITextHost_TxGetAcceleratorPos, textserv/ITextHost::TxGetAcceleratorPos
textserv.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
Msftedit.dll
Windows
19H1
ITextHost::TxGetAcceleratorPos
textserv/ITextHost::TxGetAcceleratorPos
c++
APIRef
kbSyntax
COM
Msftedit.dll
ITextHost.TxGetAcceleratorPos

ITextHost::TxGetAcceleratorPos

-description

Requests the special character to use for the underlining accelerator character.

-parameters

-param pcp

Type: LONG*

The character position of the character to underline. This variable is set by the text host. A character position of –1 (that is, negative one) indicates that no character should be underlined.

-returns

Type: HRESULT

The return value is S_OK.

-remarks

Accelerators allow keyboard shortcuts, or accelerator keys, to various UI elements (such as buttons). Typically, the shortcut character is underlined.

This method tells the text services object which character is the accelerator and thus should be underlined. Note that the text services object does not process accelerators; that is the responsibility of the host.

This method is typically only called if the TXTBIT_SHOWACCELERATOR bit is set in the text services object. See OnTxPropertyBitsChange.

Note  Any change to the text in the text services object results in the invalidation of the accelerator underlining. In this case, it is the host's responsibility to recalculate the appropriate character position and inform the text services object that a new accelerator is available.
 

-see-also

Conceptual

ITextHost

OnTxPropertyBitsChange

Reference

Windowless Rich Edit Controls