SiebPicklist Object

Description

A pick list 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 SiebPicklist object.

Note: You can also view a list and descriptions of the SiebPicklist 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, depending on the specified file extension.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the specified object property achieves the specified 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 GetItemByIndexReturns the visible text of the picklist item.Index = the index (starting at zero) of the object in the Count property.
Common Method GetROPropertyReturns the current value of the specified 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.
Method IsExistsIndicates whether the specified picklist item exists.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method ProcessKeyProcesses the specified key.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SelectSelects an item from the picklist.
Method SetTextEnters text in the picklist control (for example, when composing a query).
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the current 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

Property ActiveItemA data value (from the associated list of values) representing the currently selected item.
Property ClassNameThe class of the object.
Property CountThe number of objects of a given type that are present in the current context.
Common Property ExistChecks whether the object currently exists in the open application.
Property IsEnabledIndicates whether the object is enabled.
Property IsOpenIndicates whether the associated popup applet is open. This property is used in objects that have a popup applet.
Property IsRequiredIndicates whether the object is required.
Property RepositoryNameThe name of the object as it is stored in the repository.
Property UINameThe name of the object as it appears in the user interface.

Back to top

 

GetItemByIndex Method

Description

Returns the visible text of the picklist item.Index = the index (starting at zero) of the object in the Count property.

Syntax

object.GetItemByIndex (Index)

Arguments

ParameterDescription
Index Required. A long integer value.
The index of the item in the Count property.

Return Type

A String value.

Example

Back to top

 

IsExists Method

Description

Indicates whether the specified picklist item exists.

Syntax

object.IsExists (LOVItem)

Arguments

ParameterDescription
LOVItem Required. A String value.
The visible title of the PDQ or Picklist object.

Return Type

A long integer value.

Example

Back to top

 

ProcessKey Method

Description

Processes the specified key.

Syntax

object.ProcessKey (Key)

Arguments

ParameterDescription
Key Required. A String value.
The key to invoke.  In a pick list this key is usually the Enter key.

Return Type

None.

Example

Back to top

 

Select Method

Description

Selects an item from the picklist.

Syntax

object.Select (LOVItem)

Arguments

ParameterDescription
LOVItem Required. A String value.
The visible text of the picklist item.

Return Type

None.

Example

Back to top

 

SetText Method

Description

Enters text in the picklist control (for example, when composing a query).

Syntax

object.SetText (Text)

Arguments

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

Return Type

None.

IMPORTANT

The SetText method fails on picklists that are used as applet toggle controls.

Example

Back to top

 

ActiveItem Property

Description

A data value (from the associated list of values) representing the currently selected item.

Syntax

object.ActiveItem

Value Type

A String value.

Property type

Read-only property

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

Example

Back to top

 

Count Property

Description

The number of objects of a given type that are present in the current context.

Syntax

object.Count

Value Type

A long integer value.

Property type

Read-only property

Example

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

 

IsOpen Property

Description

Indicates whether the associated popup applet is open. This property is used in objects that have a popup applet.

Syntax

object.IsOpen

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

 

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

 

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: