Object Model Reference for GUI Testing > Siebel > ProcessKey Method

SiebText Object

Description

A text box in a Siebel test automation environment.

Operations

The sections below list the built-in methods and properties that you can use as operations for the SiebText object.

Note: You can also view a list and descriptions of the SiebText description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image, depending on the specified file extension.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the specified object property achieves the specified value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Common Method GetROProperty Returns the current value of the specified description properties from the object in the application.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the current value of the specified description properties from the object in the application.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Method ProcessKey Processes the specified key.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method SetText Enters text into the text box.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Common Method ToString Returns a string that represents the current test object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Property ClassName The class of the object.
Common Property Exist Checks whether the object currently exists in the open application.
Property IsEnabled Indicates whether the object is enabled.
Property IsEncrypted Indicates whether the text value of the object is masked, such as in a password text box.
Property IsRequired Indicates whether the object is required.
Property PopupType The type of popup associated with the text box.
Property RepositoryName The name of the object as it is stored in the repository.
Property Text The text value of the object.
Property UIName The name of the object as it appears in the user interface.

 

Back to top

ProcessKey Method

Description

Processes the specified key.

Syntax

object.ProcessKey (Key)

Arguments

Parameter Description
Key Required. A String value.
The key to invoke.  In a text box, this key is usually the Enter key.

Return Type

None.

Example


 

Back to top

SetText Method

Description

Enters text into the text box.

Syntax

object.SetText (Text)

Arguments

Parameter Description
Text Required. A String value.
The text to enter.

Return Type

None.

Example


 

Back to top

ClassName Property

Description

The class of the object.

Syntax

object.ClassName

Value Type

A String value.

Property type

Read-only property


 

Back to top

IsEnabled Property

Description

Indicates whether the object is enabled.

Syntax

object.IsEnabled

Value Type

A long integer value.

Property type

Read-only property

Example


 

Back to top

IsEncrypted Property

Description

Indicates whether the text value of the object is masked, such as in a password text box.

Syntax

object.IsEncrypted

Value Type

A long integer value.

Property type

Read-only property

Example


 

Back to top

IsRequired Property

Description

Indicates whether the object is required.

Syntax

object.IsRequired

Value Type

A long integer value.

Property type

Read-only property

Example


 

Back to top

PopupType Property

Description

The type of popup associated with the text box.

Syntax

object.PopupType

Value Type

A String value.

Property type

Read-only property

Example


 

Back to top

RepositoryName Property

Description

The name of the object as it is stored in the repository.

Syntax

object.RepositoryName

Value Type

A String value.

Property type

Read-only property


 

Back to top

Text Property

Description

The text value of the object.

Syntax

object.Text

Value Type

A String value.

Property type

Read-only property

Example


 

Back to top

UIName Property

Description

The name of the object as it appears in the user interface.

Syntax

object.UIName

Value Type

A String value.

Property type

Read-only property

Example


Back to top

See also: