KeyboardAction Class

Article
03/28/2012

Represents individual keyboard user actions.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.TestTools.UITest.Common.UITestAction
    Microsoft.VisualStudio.TestTools.UITest.Common.InputAction
      Microsoft.VisualStudio.TestTools.UITest.Common.KeyboardAction

Namespace: Microsoft.VisualStudio.TestTools.UITest.Common
Assembly: Microsoft.VisualStudio.TestTools.UITest.Common (in Microsoft.VisualStudio.TestTools.UITest.Common.dll)

Syntax

'Declaration
Public Class KeyboardAction _
    Inherits InputAction

public class KeyboardAction : InputAction

public ref class KeyboardAction : public InputAction

type KeyboardAction =  
    class
        inherit InputAction
    end

public class KeyboardAction extends InputAction

The KeyboardAction type exposes the following members.

Constructors

	Name	Description
	KeyboardAction()	Initializes a new instance of the KeyboardAction class for XML serialization or deserialization.
	KeyboardAction(KeyActionType, Keys, String)	Initializes a new instance of the KeyboardAction class by using the provided type of key event, the key that was pressed, and the value that was generated by that key.
	KeyboardAction(UITechnologyElement, KeyActionType, Keys, String)	Initializes a new instance of the KeyboardAction class by using the provided element, type of key event, the key that was pressed, and the value that was generated by that key.

Top

Properties

	Name	Description
	ActionName	Gets or sets the name of this action. (Overrides UITestAction.ActionName.)
	ActionType	Gets or sets the type of keyboard operation.
	ActualThinkTime	Gets or sets the think time after processing other playback parameters that are provided by the UIActionInterpreter, such as the ThinkTimeMultiplier. (Inherited from UITestAction.)
	AdditionalInfo	Gets additional information about this action. The information is usually used by an aggregator of test actions. The set procedure is not supported in this class. (Overrides UITestAction.AdditionalInfo.)
	Comment	Gets or sets a comment for this action. (Inherited from UITestAction.)
	ContinueOnError	Gets or sets a value that indicates whether to continue even if this action fails. (Inherited from UITestAction.)
	ContinueOnErrorWrapper	Gets or sets the value of the ContinueOnError property as a string for serialization. (Inherited from UITestAction.)
	ElapsedTime	Gets or sets the time span of the action. (Inherited from UITestAction.)
	EndTimestamp	The timestamp for the end of the action. (Inherited from UITestAction.)
	Id	Gets or sets a unique numerical identifier for this action. (Inherited from UITestAction.)
	IsGlobalHotkey	Gets or sets a value that indicates whether the input is a global keyboard shortcut. (Inherited from InputAction.)
	IsParameterBound	If this action can be parameterized, gets or sets a value that indicates whether the action is bound to a test parameter. (Inherited from UITestAction.)
	IsParameterizable	Gets a value that indicates whether this action can be parameterized. (Inherited from UITestAction.)
	Key	Gets or sets the key that was pressed.
	KeyValue	Gets or sets the input value that was generated by the key press.
	ModifierKeys	Gets or sets which modifier keys were pressed. (Inherited from InputAction.)
	NeedFiltering	Gets or sets a value that indicates whether this action can be processed by a UITestActionFilter. (Inherited from UITestAction.)
	ParameterName	Gets or sets the name of the corresponding parameter for the action value. (Inherited from UITestAction.)
	StartTimestamp	Gets or sets the starting time stamp when executing this action. (Inherited from UITestAction.)
	Tags	Gets a dictionary of additional information about this action that is needed during recording, aggregation, or post-processing. The set procedure is private. (Inherited from UITestAction.)
	ThinkTime	Gets or sets the number of seconds that are required to execute this action. (Inherited from UITestAction.)
	ThinkTimeString	Gets or sets the think time for this action by using a string value. (Inherited from UITestAction.)
	Timestamp	Gets or sets the time stamp for this action. (Inherited from UITestAction.)
	UIElement	Gets or sets the UI element on which this action operates. (Inherited from UITestAction.)
	UIObjectName	Gets or sets the name of the UI element on which this action operates. (Inherited from UITestAction.)
	ValueAsString	Gets or the input value as a string. The set procedure is not supported in this class. (Overrides UITestAction.ValueAsString.)

Top

Methods

	Name	Description
	Equals	Returns a value that indicates whether the given object is equal to this UI test action. (Inherited from UITestAction.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from UITestAction.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Invoke	Invokes this action. (Overrides UITestAction.Invoke(UITestActionInvoker, UIMap).)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyPropertyChanged	Raises the PropertyChanged event. (Inherited from UITestAction.)
	ToString	Returns the description of this action. (Inherited from UITestAction.)

Top

Events

	Name	Description
	PropertyChanged	Occurs when a property value changes. (Inherited from UITestAction.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via