Package at.bestsolution.uia

Interface ISynchronizedInputProvider

All Superinterfaces:

IInitable

public interface ISynchronizedInputProvider
extends IInitable

Enables Microsoft UI Automation client applications to direct the mouse or keyboard input to a specific UI element.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ISynchronizedInputProvider.SynchronizedInputProviderContext	context object for ISynchronizedInputProvider.

Method Summary

Modifier and Type	Method	Description
void	Cancel()	Cancels listening for input.
void	StartListening(SynchronizedInputType inputType)	Starts listening for input of the specified type.

Methods inherited from interface at.bestsolution.uia.IInitable

initialize

Method Details

Cancel

void Cancel()

Cancels listening for input.

If the provider is currently listening for input, it should revert to normal operation.

StartListening

void StartListening(SynchronizedInputType inputType)

Starts listening for input of the specified type.

When it finds matching input, the provider checks if the target UI Automation element matches the current element. If they match, the provider raises the UIA_InputReachedTargetEventId event; otherwise, it raises the UIA_InputReachedOtherElementEventId or UIA_InputDiscardedEventId event. The UI Automation provider must discard the input if it is for an element other than this one. This is a one-shot method; after receiving input, the provider stops listening and continues normally. This method returns E_INVALIDOPERATION if the provider is already listening for input.

Parameters:

inputType - The type of input that is requested to be synchronized.