C# Class ACAT.Extensions.Default.FunctionalAgents.SwitchWindowsAgent.SwitchWindowsAgent

Inheritance: ACAT.Lib.Core.AgentManagement.FunctionalAgentBase

Datei anzeigen Open project: brlima94/acat-localization

Public Methods

Method	Description
Activate ( ) : bool	Invoked when the Functional agent is activated. This is the entry point.
CheckWidgetEnabled ( ACAT.Lib.Core.AgentManagement.CheckEnabledArgs arg ) : void	Invoked to check if a scanner button should be enabled. Uses context to determine the 'enabled' state.
OnFocusChanged ( ACAT.Lib.Core.Utility.WindowActivityMonitorInfo monitorInfo, bool &handled ) : void	Invoked when the focus changes either in the active window or when the active window itself changes.
OnRequestClose ( ) : bool	A request came in to close the agent. We MUST quit if this call is ever made
OnRunCommand ( String command, object commandArg, bool &handled ) : void	Invoked when there is a request to run a command. This could as a result of the user activating a button on the scanner and there is a command associated with the button
SwitchWindowsAgent ( ) : System	Initializes a new instance of the class.

Protected Methods

Method	Description
createEditControlTextInterface ( IntPtr handle, AutomationElement focusedElement, bool &handled ) : ACAT.Lib.Core.AgentManagement.TextInterface.TextControlAgentBase	Creates and returns the text control interface for the agent

Private Methods

Method	Description
_form_EvtDone ( ) : void	We are done. Quit after confirmation
_form_FormClosing ( object sender, FormClosingEventArgs e ) : void	Release resources, reinitialize for next activation
_switchWindowsScanner_EvtActivateWindow ( object sender, ACAT.Lib.Core.Utility.EnumWindows windowInfo ) : void	Invoked when the selects a window in the switch windows scanner. Set focus to the selected window and quit the agent.
closeScanner ( ) : void	Close the switch windows scanner
confirm ( String prompt ) : bool	Get confirmation from the user
quit ( ) : void	Close all scanners and quit
subscribeToEvents ( ) : void	Subscribes to events
switchWindows_EvtShowScanner ( object sender, EventArgs eventArgs ) : void	Event handler to display alphabet scanner
unsubscribeFromEvents ( ) : void	Unsubscribes events

Method Details

Activate() public method

Invoked when the Functional agent is activated. This is the entry point.

public Activate ( ) : bool
return	bool

CheckWidgetEnabled() public method

Invoked to check if a scanner button should be enabled. Uses context to determine the 'enabled' state.

public CheckWidgetEnabled ( ACAT.Lib.Core.AgentManagement.CheckEnabledArgs arg ) : void
arg	ACAT.Lib.Core.AgentManagement.CheckEnabledArgs	info about the scanner button
return	void

OnFocusChanged() public method

Invoked when the focus changes either in the active window or when the active window itself changes.

public OnFocusChanged ( ACAT.Lib.Core.Utility.WindowActivityMonitorInfo monitorInfo, bool &handled ) : void
monitorInfo	ACAT.Lib.Core.Utility.WindowActivityMonitorInfo	Info about focused element
handled	bool	was this handled
return	void

OnRequestClose() public method

A request came in to close the agent. We MUST quit if this call is ever made

public OnRequestClose ( ) : bool
return	bool

OnRunCommand() public method

Invoked when there is a request to run a command. This could as a result of the user activating a button on the scanner and there is a command associated with the button

public OnRunCommand ( String command, object commandArg, bool &handled ) : void
command	String	command to run
commandArg	object	any optional arguments
handled	bool	was this handled?
return	void

SwitchWindowsAgent() public method

Initializes a new instance of the class.

public SwitchWindowsAgent ( ) : System
return	System

createEditControlTextInterface() protected method

Creates and returns the text control interface for the agent

protected createEditControlTextInterface ( IntPtr handle, AutomationElement focusedElement, bool &handled ) : ACAT.Lib.Core.AgentManagement.TextInterface.TextControlAgentBase
handle	System.IntPtr	handle to the edit control
focusedElement	System.Windows.Automation.AutomationElement	automation element
handled	bool	was this handled?
return	ACAT.Lib.Core.AgentManagement.TextInterface.TextControlAgentBase