Object Model Reference for GUI Testing > Siebel > Close Method

SiebTaskUIPane Object

Description

The task UI pane 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 SiebTaskUIPane object.

Note: You can also view a list and descriptions of the SiebTaskUIPane 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.
Method Close Closes the task list
Method GetClassCount Returns the number of objects of the specified class type.
Method GetRepositoryNameByIndex Returns the RepositoryName of the specified object.
Common Method GetROProperty Returns the current value of the specified description properties from the object in the application.
Method GetStepByIndex Returns the visible text of the specified step.
Method GetTaskByIndex Returns the visible text of the specified task.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method GotoInbox Clicks the Go to Inbox link.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method Start Clicks the link of the specified task to start that task.
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 ActiveTask The name of the current task.
Property ClassName The class of the object.
Common Property Exist Checks whether the object currently exists in the open application.
Property RepositoryName The name of the object as it is stored in the repository.
Property StepCount The number of steps in the current task.
Property TaskCount The number of tasks in the current list.
Property UIName The name of the object as it is appears in the user interface.

 

Back to top

Close Method

Description

Closes the task list

Syntax

object.Close

Return Type

None.

Example


 

Back to top

GetClassCount Method

Description

Returns the number of objects of the specified class type.

Syntax

object.GetClassCount (ClassName)

Arguments

Parameter Description
ClassName Required. A String value.
The type of object to be counted.

Return Type

A long integer value.


 

Back to top

GetRepositoryNameByIndex Method

Description

Returns the RepositoryName of the specified object.

Syntax

object.GetRepositoryNameByIndex (ClassName, Index)

Arguments

Parameter Description
ClassName Required. A String value.
The ClassName of the object.
Index Required. A long integer value.
The index of the object in the value returned by the GetClassCount method.

Return Type

A String value.


 

Back to top

GetStepByIndex Method

Description

Returns the visible text of the specified step.

Syntax

object.GetStepByIndex (Index)

Arguments

Parameter Description
Index Required. A long integer value.
The index of the task.

Return Type

A String value.


 

Back to top

GetTaskByIndex Method

Description

Returns the visible text of the specified task.

Syntax

object.GetTaskByIndex (Index)

Arguments

Parameter Description
Index Required. A long integer value.
The index of the task.

Return Type

A String value.

Example


 

Back to top

GotoInbox Method

Description

Clicks the Go to Inbox link.

Syntax

object.GotoInbox

Return Type

None.

Example


 

Back to top

Start Method

Description

Clicks the link of the specified task to start that task.

Syntax

object.Start (TaskName, TaskGroup)

Arguments

Parameter Description
TaskName Required. A String value.
The RepositoryName of the task.
TaskGroup Required. A String value.
The group to which the task belongs.

Return Type

None.


 

Back to top

ActiveTask Property

Description

The name of the current task.

Syntax

object.ActiveTask

Value Type

A String value.

Property type

Read-only property


 

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

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

StepCount Property

Description

The number of steps in the current task.

Syntax

object.StepCount

Value Type

A long integer value.

Property type

Read-only property


 

Back to top

TaskCount Property

Description

The number of tasks in the current list.

Syntax

object.TaskCount

Value Type

A long integer value.

Property type

Read-only property

Example


 

Back to top

UIName Property

Description

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

Syntax

object.UIName

Value Type

A String value.

Property type

Read-only property

Example


Back to top

See also: