SAPGuiTextArea Object

Description

A text area in an SAP GUI for Windows application.

Operations

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

Note: You can also view a list and descriptions of the SAPGuiTextArea 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 CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method DoubleClickDouble-clicks inside a text area at the cursor position.
Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SetSets the specified text in the text area.
Method SetSelectionIndexesSelects the specified section of text in the text area and positions the cursor.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method SetUnprotectedTextPartSets the specified text in the predefined unprotected sections of the text area.
Common Method ToStringReturns a string that represents the test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the object.

Back to top

 

DoubleClick Method

Description

Double-clicks inside a text area at the cursor position.

Syntax

object.DoubleClick

Return Type

None.

Example

Back to top

 

Set Method

Description

Sets the specified text in the text area.

Syntax

object.Set (Text)

Arguments

ParameterDescription
Text Required. A String value.
The text to set in the text area.

Return Type

None.

Example

Back to top

 

SetSelectionIndexes Method

Description

Selects the specified section of text in the text area and positions the cursor.

Syntax

object.SetSelectionIndexes (Start, End)

Arguments

ParameterDescription
Start Required. A long integer value.
The position of the first character of the text to be selected (highlighted) in the text area.
Character position numbering starts from zero.
End Required. A long integer value.
The position of the character that ends the selection in the text area (this character is not highlighted). The cursor is set to this position.
If Start = End, no text is highlighted and the cursor is set to this character position.

Return Type

None.

IMPORTANT

The text is selected from the specified start character and up to, but not including, the end character.

Example

Back to top

 

SetUnprotectedTextPart Method

Description

Sets the specified text in the predefined unprotected sections of the text area.

Syntax

object.SetUnprotectedTextPart (Part, Text)

Arguments

ParameterDescription
Part Required. A long integer value.
The number of the unprotected section in which the text is set. Unprotected sections of the text area are numbered from top to bottom, starting from 1.
Text Required. A String value.
The text to set in the specified unprotected part of the text area.

Return Type

None.

Example

Back to top

See also: