Object Model Reference for GUI Testing > Siebel > Close Method

SiebTaskAssistant Object

Description

The Task Assistant 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 SiebTaskAssistant object.

Note: You can also view a list and descriptions of the SiebTaskAssistant 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 Done Clicks the Return To link.
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 value of the specified description properties from the test object description.
Method Next Clicks the See additional steps 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 a task.
Method Step Clicks the specified step.
Method StepView Clicks the View link for the specified step.
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 ActiveStepNum Closes the task list.
Property ActiveTask The name of the current task.
Property ActiveTaskId The Id 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 visible steps.
Property TaskCount The number of tasks in the current list.
Property UIName The name of the object as it 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

Done Method

Description

Clicks the Return To link.

Syntax

object.Done

Return Type

None.

Example


 

Back to top

Next Method

Description

Clicks the See additional steps link.

Syntax

object.Next

Return Type

None.

Example


 

Back to top

Start Method

Description

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

Syntax

object.Start (TaskIndex)

Arguments

Parameter Description
TaskIndex Required. A String value.
The Id of the task to start.

Return Type

None.

Example


 

Back to top

Step Method

Description

Clicks the specified step.

Syntax

object.Step (StepNum)

Arguments

Parameter Description
StepNum Required. A String value.
The number of the step.

Return Type

None.

Example


 

Back to top

StepView Method

Description

Clicks the View link for the specified step.

Syntax

object.StepView (StepNum)

Arguments

Parameter Description
StepNum Required. A String value.
The number of the step.

Return Type

None.

Example


 

Back to top

ActiveStepNum Property

Description

Closes the task list.

Syntax

object.ActiveStepNum

Value Type

A long integer value.

Property type

Read-only property

Example


 

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

Example


 

Back to top

ActiveTaskId Property

Description

The Id of the current task.

Syntax

object.ActiveTaskId

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

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 visible steps.

Syntax

object.StepCount

Value Type

A long integer value.

Property type

Read-only property

Example


 

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 appears in the user interface.

Syntax

object.UIName

Value Type

A String value.

Property type

Read-only property

Example


Back to top

See also: