SiebList Object

Description

A list object in a Siebel test automation environment.

IMPORTANT

If you want to access an inner object contained in a SiebList object when using the pointing hand mechanism (when using the Object Spy or creating a checkpoint or output value), hold the Ctrl key while you click the SiebList object.

Operations

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

Note: You can also view a list and descriptions of the SiebList 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

Method ActivateRowActivates a row in the list.
Method AscendSortSorts the list on the column in ascending order.
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 ClickHierToggles the active row between expanded and collapsed (for hierarchical lists).
Method DescendSortSorts the list on the column in descending order.
Method DoubleClickDouble click a row in the list.
Method DrillDownColumnClicks a drilldown link.
Method FirstRowSetNavigates to the first set of records in the list.
Method GetActiveControlNameReturns the name of the active control.
Method GetCellTextReturns the text of the specified cell.
Method GetColumnRepositoryNameReturns the RepositoryName of the specified column.
Method GetColumnRepositoryNameByIndexReturns the RepositoryName of the specified column.
Method GetColumnSortIndicates how the specified column is currently sorted (Ascend or Descend or None).
Method GetColumnUINameReturns the UIName of the specified column.
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 GetTotalsValueReturns the value in the totals row for the specified column. Returns an empty String if the column does not have a totals row.
Method IsColumnDrillDownReturns TRUE if the specified column is a drilldown column, and FALSE if it is not.
Method IsColumnExistsIndicates whether the specified column exists.
Method IsRowExpandedIndicates whether the row is expanded (TRUE) or collapsed (FALSE).
Method LastRowSetNavigates to the last set of records in the list.
Method NextRowNavigates to the next row in the list.
Method NextRowSetNavigates to the next set of records in the list.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method PreviousRowNavigates to the previous row in the list.
Method PreviousRowSetNavigates to the previous set of records in the list.
Common Method RefreshObjectInstructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object.
Method SelectRowActivates a row in conjunction with a multiselect key.
Method SetActiveControlSets the focus in the specified control.
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 ActiveRowSpecifies which row is currently active. (based on the number of currently visible rows determined by show more/less)
Property ClassNameThe class of the object.
Property ColumnsCountSpecifies the number of currently visible columns in the list.
Common Property ExistChecks whether the object currently exists in the open application.
Property RepositoryNameThe name of the object as it is stored in the repository.
Property RowsCountSpecifies the number of currently visible rows. (determined by show more/less)
Property SelectedRowsA pipe-delimited string of row numbers that are currently selected.
Property UINameThe name of the object as it appears in the user interface.

Back to top

 

ActivateRow Method

Description

Activates a row in the list.

Syntax

object.ActivateRow (RowId)

Arguments

ParameterDescription
RowId Required. A long integer value.
The row to activate, based on the number of currently visible rows (determined by show more and show less).

Return Type

None.

Example

Back to top

 

AscendSort Method

Description

Sorts the list on the column in ascending order.

Syntax

object.AscendSort (ColumnName)

Arguments

ParameterDescription
ColumnName Required. A String value.
The RepositoryName of the column on which to sort.

Return Type

None.

Example

Back to top

 

ClickHier Method

Description

Toggles the active row between expanded and collapsed (for hierarchical lists).

Syntax

object.ClickHier

Return Type

None.

Back to top

 

DescendSort Method

Description

Sorts the list on the column in descending order.

Syntax

object.DescendSort (ColumnName)

Arguments

ParameterDescription
ColumnName Required. A String value.
The RepositoryName of the column on which to sort.

Return Type

None.

Example

Back to top

 

DoubleClick Method

Description

Double click a row in the list.

Syntax

object.DoubleClick (RowId, ColumnName)

Arguments

ParameterDescription
RowId Required. A long integer value.
The row number of the item to double-click.
ColumnName Required. A String value.
The column name of the item to double-click.

Return Type

None.

Example

Back to top

 

DrillDownColumn Method

Description

Clicks a drilldown link.

Syntax

object.DrillDownColumn (ColumnName, RowId)

Arguments

ParameterDescription
ColumnName Required. A String value.
The RepositoryName of the column that contains the drilldown link.
RowId Required. A long integer value.
The row that contains the drilldown link, based on the number of currently visible rows (determined by show more/less).

Return Type

None.

Example

Back to top

 

FirstRowSet Method

Description

Navigates to the first set of records in the list.

Syntax

object.FirstRowSet

Return Type

None.

Example

Back to top

 

GetActiveControlName Method

Description

Returns the name of the active control.

Syntax

object.GetActiveControlName

Return Type

A long integer value.

Back to top

 

GetCellText Method

Description

Returns the text of the specified cell.

Syntax

object.GetCellText (ColumnName, RowNum)

Arguments

ParameterDescription
ColumnName Required. A String value.
The RepositoryName of the column containing the cell.
RowNum Required. A long integer value.
The number of the row containing the cell.

Return Type

A String value.

Example

Back to top

 

GetColumnRepositoryName Method

Description

Returns the RepositoryName of the specified column.

Syntax

object.GetColumnRepositoryName (ColumnName)

Arguments

ParameterDescription
ColumnName Required. A String value.
The UIName of the column.

Return Type

A String value.

Example

Back to top

 

GetColumnRepositoryNameByIndex Method

Description

Returns the RepositoryName of the specified column.

Syntax

object.GetColumnRepositoryNameByIndex (ColumnName)

Arguments

ParameterDescription
ColumnName Required. A long integer value.
The index number of the column.

Return Type

A String value.

Example

Back to top

 

GetColumnSort Method

Description

Indicates how the specified column is currently sorted (Ascend or Descend or None).

Syntax

object.GetColumnSort (ColumnName)

Arguments

ParameterDescription
ColumnName Required. A String value.
The RepositoryName of the column.

Return Type

A String value.

Example

Back to top

 

GetColumnUIName Method

Description

Returns the UIName of the specified column.

Syntax

object.GetColumnUIName (ColumnName)

Arguments

ParameterDescription
ColumnName Required. A String value.
The RepositoryName of the column.

Return Type

A String value.

Example

Back to top

 

GetTotalsValue Method

Description

Returns the value in the totals row for the specified column. Returns an empty String if the column does not have a totals row.

Syntax

object.GetTotalsValue (ColumnName)

Arguments

ParameterDescription
ColumnName Required. A String value.
The RepositoryName of the column.

Return Type

A String value.

Example

Back to top

 

IsColumnDrillDown Method

Description

Returns TRUE if the specified column is a drilldown column, and FALSE if it is not.

Syntax

object.IsColumnDrillDown (ColumnName)

Arguments

ParameterDescription
ColumnName Required. A String value.
The RepositoryName of the column.

Return Type

A long integer value.

Example

Back to top

 

IsColumnExists Method

Description

Indicates whether the specified column exists.

Syntax

object.IsColumnExists (ColumnName)

Arguments

ParameterDescription
ColumnName Required. A String value.
The RepositoryName of the column.

Return Type

A long integer value.

Example

Back to top

 

IsRowExpanded Method

Description

Indicates whether the row is expanded (TRUE) or collapsed (FALSE).

Syntax

object.IsRowExpanded (RowId)

Arguments

ParameterDescription
RowId Required. A long integer value.
The number of the row.

Return Type

None.

Example

Back to top

 

LastRowSet Method

Description

Navigates to the last set of records in the list.

Syntax

object.LastRowSet

Return Type

None.

Example

Back to top

 

NextRow Method

Description

Navigates to the next row in the list.

Syntax

object.NextRow

Return Type

None.

Example

Back to top

 

NextRowSet Method

Description

Navigates to the next set of records in the list.

Syntax

object.NextRowSet

Return Type

None.

Example

Back to top

 

PreviousRow Method

Description

Navigates to the previous row in the list.

Syntax

object.PreviousRow

Return Type

None.

Example

Back to top

 

PreviousRowSet Method

Description

Navigates to the previous set of records in the list.

Syntax

object.PreviousRowSet

Return Type

None.

Example

Back to top

 

SelectRow Method

Description

Activates a row in conjunction with a multiselect key.

Syntax

object.SelectRow (RowNum, SelectType)

Arguments

ParameterDescription
RowNum Required. A long integer value.
The row to activate, based on the number of currently visible rows (determined by show more and show less).
SelectType Required. A String value.
The multiselect key (either Shift or Control) to use. If SelectType is an empty string, no multiselect key is used.

Return Type

None.

Example

Back to top

 

SetActiveControl Method

Description

Sets the focus in the specified control.

Syntax

object.SetActiveControl (ControlName)

Arguments

ParameterDescription
ControlName Required. A String value.
The RepositoryName of the control.

Return Type

None.

Back to top

 

ActiveRow Property

Description

Specifies which row is currently active. (based on the number of currently visible rows determined by show more/less)

Syntax

object.ActiveRow

Value Type

A long integer 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

 

ColumnsCount Property

Description

Specifies the number of currently visible columns in the list.

Syntax

object.ColumnsCount

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

 

RowsCount Property

Description

Specifies the number of currently visible rows. (determined by show more/less)

Syntax

object.RowsCount

Value Type

A long integer value.

Property type

Read-only property

Example

Back to top

 

SelectedRows Property

Description

A pipe-delimited string of row numbers that are currently selected.

Syntax

object.SelectedRows

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: