Edit

Share via

IUIAutomationEventHandlerGroup::AddTextEditTextChangedEventHandler method (uiautomationclient.h)

  • Article

Registers a method that handles programmatic text-edit events.

Important  Microsoft UI Automation clients should use the handler group methods to register event listeners instead of individual event registration methods defined in the various IUIAutomation namespaces.
 

Syntax

HRESULT AddTextEditTextChangedEventHandler(
  [in] TreeScope                                    scope,
  [in] TextEditChangeType                           textEditChangeType,
  [in] IUIAutomationCacheRequest                    *cacheRequest,
  [in] IUIAutomationTextEditTextChangedEventHandler *handler
);

Parameters

[in] scope

The scope of events to be handled; that is, whether they are on the element itself, or on its ancestors and descendants.

[in] textEditChangeType

The specific change type to listen for. Clients register for each text-edit change type separately, so that the UI Automation system can check for registered listeners at run-time and avoid raising events for particular text-edit changes when there are no listeners.

[in] cacheRequest

A pointer to a cache request, or NULL if no caching is wanted.

[in] handler

A pointer to the object that handles the programmatic text-edit event.

Return value

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

Remarks

Before implementing an event handler, you should be familiar with the threading issues described in Understanding Threading Issues.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1809 [desktop apps only]
Minimum supported server Windows Server, version 1709 [desktop apps only]
Target Platform Windows
Header uiautomationclient.h (include UIAutomation.h)

See also

IUIAutomationEventHandlerGroup