IRawElementProviderAdviseEvents interface

Exposes methods that are called to notify the root element of a fragment when a Microsoft UI Automation client application begins or ends listening for events on that fragment.

Methods

The IRawElementProviderAdviseEvents interface has these methods.

Method Description
IRawElementProviderAdviseEvents::AdviseEventAdded Notifies the Microsoft UI Automation provider when a UI Automation client begins listening for a specific event, including a property-changed event.
IRawElementProviderAdviseEvents::AdviseEventRemoved Notifies the Microsoft UI Automation provider when a UI Automation client stops listening for a specific event, including a property-changed event.

Remarks

Implementation of this interface is optional. It can be used to improve performance by raising events only when they are being listened for.

Similar to implementing reference counting in Component Object Model (COM) programming, it is important for UI Automation providers to treat the AdviseEventAdded and AdviseEventRemoved methods like the AddRef and Release methods of the IUnknown interface. As long as AdviseEventAdded has been called more times than AdviseEventRemoved for a specific event or property, the provider should continue to raise corresponding events, because some clients are still listening. Alternatively, UI Automation providers can use the UiaClientsAreListening function to determine if at least one client is listening and, if so, raise all appropriate events.

Requirements

   
Minimum supported client Windows XP [desktop apps | UWP apps]
Minimum supported server Windows Server 2003 [desktop apps | UWP apps]
Target Platform Windows
Header uiautomationcore.h (include UIAutomation.h)