SiebPageTabs Object

Description

A page tab 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 SiebPageTabs object.

Note: You can also view a list and descriptions of the SiebPageTabs 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 GetRepositoryNameReturns the RepositoryName of the object.
Method GetRepositoryNameByIndexReturns the RepositoryName of the item with the specified index.
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 GetUINameReturns the name of the object as it is appears in the user interface.
Method GotoScreenNavigates to a PageTab.
Method GotoViewNavigates to a View.
Method IsExistsIndicates whether the specified object exists.
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.
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 ActiveScreenThe RepositoryName of the active PageTab object.
Property ActiveViewThe RepositoryName of the active View, as represented by the active Aggregate Category link.
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 RepositoryNameThe name of the object as it is stored in the repository.
Property ScreenCountThe number of screen objects that are present in the current context.
Property UINameThe name of the object as it appears in the user interface.
Property ViewCountThe number of view objects that are present in the current context.

Back to top

 

GetRepositoryName Method

Description

Returns the RepositoryName of the object.

Syntax

object.GetRepositoryName (UIName, Origin)

Arguments

ParameterDescription
UIName Required. A String value.
The UIName of the PageTab or View object.
Origin Required. A String value.

The type (Screen or View) of navigation object.
Possible values:
"Screen"--refers to the top items on the PageTab
"View"-- refers to the bottom items on the PageTab
""--uses the default value ("Screen")
Note: When Origin is defined as Screen, then UIName should specify the display name for a PageTab object. When Origin is defined as View, then UIName should specify the display name for a View as represented by an Aggregate Category link.

Return Type

A String value.

The repository name of the specified child object.

IMPORTANT

The specified object must be a direct child object of the SiebPageTabs object.

Example

                    'The following example uses the GetRepositoryName method to return the
'repository name of the "Accounts" item in the top part of the PageTab object,
'and then writes this information to the run results.

var_GetRepositoryName = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GetRepositoryName("Accounts", "Screen")
Reporter.ReportEvent 2, "GetRepositoryName for SiebPageTabs object  ", " returns:  " & var_GetRepositoryName

Back to top

 

GetRepositoryNameByIndex Method

Description

Returns the RepositoryName of the item with the specified index.

Syntax

object.GetRepositoryNameByIndex (Index, Origin)

Arguments

ParameterDescription
Index Required. A long integer value.
The index of the PageTab or View object in the corresponding Count property (ScreenCount or ViewCount).
Origin Required. A String value.

The type (Screen or View) of navigation object.
Possible values:
"Screen"--refers to the top items on the PageTab
"View"-- refers to the bottom items on the PageTab
""--uses the default value ("Screen")
Note: When Origin is defined as Screen, then Index should be an index into the ScreenCount property. When Origin is defined as View, then Index should be specified as an index into the ViewCount property.

Return Type

A String value.

Example

                    'The following example uses the GetRepositoryNameByIndex method to return
'the repository name of the item with index "1" in the PageTab object, and
'then writes this information to the run results.

var_GetRepositoryNameByIndex = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GetRepositoryNameByIndex(1)
Reporter.ReportEvent 2, "GetRepositoryNameByIndex  for the 1-st SiebPageTabs object   ", " returns:  " & var_GetRepositoryNameByIndex

Back to top

 

GetUIName Method

Description

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

Syntax

object.GetUIName (RepositoryName, Origin)

Arguments

ParameterDescription
RepositoryName Required. A String value.
The RepositoryName of the PageTab or View object.
Origin Required. A String value.

The type of navigation object.
Possible values:
"Screen"--refers to the top items on the PageTab
"View"-- refers to the bottom items on the PageTab
""--uses the default value ("Screen")

Return Type

A String value.

Example

                    'The following example uses the GetUIName method to return the user
'interface name of the item with index "1" in the PageTab object, and then
'writes this information to the run results.

var_GetRepositoryNameByIndex = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GetRepositoryNameByIndex(1)
var_GetUIName = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GetUIName(var_GetRepositoryNameByIndex)
Reporter.ReportEvent 2, "GetUIName for SiebPageTabs object  ", " returns:  " & var_GetUIName

Back to top

 

GotoScreen Method

Description

Navigates to a PageTab.

Syntax

object.GotoScreen (Screen)

Arguments

ParameterDescription
Screen Required. A String value.
The RepositoryName of the PageTab object.

Return Type

None.

Example

                    'The following example uses the GotoScreen method to navigate to the
'"Accounts Screen" screen.

SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoScreen "Accounts Screen"

Back to top

 

GotoView Method

Description

Navigates to a View.

Syntax

object.GotoView (View)

Arguments

ParameterDescription
View Required. A String value.
The RepositoryName of the View object, represented by an Aggregate Category link.

Return Type

None.

Example

'The following example finds the repository name of one view,
'navigates to the home view, and then navigates back to the original view
'based on the previously saved repository name

Dim reposName
reposName = SiebApplication("Siebel Call Center").SiebScreen("Accounts").GetRepositoryName("SiebView", "My Accounts")
SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoView "Account Screen Homepage View"
SiebApplication("Siebel Call Center").SiebScreen("Accounts").GotoView (reposName)

                    'The following example uses the GotoView method to navigate to the
'"Account List View" View.

SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoView "Account List View"

Back to top

 

IsExists Method

Description

Indicates whether the specified object exists.

Syntax

object.IsExists (RepositoryName, Origin)

Arguments

ParameterDescription
RepositoryName Required. A String value.
The RepositoryName of the PageTab or View object.
Origin Required. A String value.
The type of navigation object.
Possible values:
"Screen"--refers to the top items on the PageTab
"View"-- refers to the bottom items on the PageTab
""--uses the default value ("Screen")

Return Type

A long integer value.

Example

                    'The following example uses the IsExists method to check whether the PageTab
'item with index "1" exists, and then writes this information to the test
'results.

var_GetRepositoryNameByIndex = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GetRepositoryNameByIndex(1)
var_IsExists = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").IsExists(var_GetRepositoryNameByIndex)
Reporter.ReportEvent 2, "IsExists for SiebPageTabs object  ", " returns:  " & var_IsExists

Back to top

 

ActiveScreen Property

Description

The RepositoryName of the active PageTab object.

Syntax

object.ActiveScreen

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the ActiveScreen property to return the
'repository name of the active PageTab, and then writes this information
'to the run results.

var_ActiveScreen = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").ActiveScreen
Reporter.ReportEvent 2, "ActiveScreen for SiebPageTabs object  ", " returns:  " & var_ActiveScreen

Back to top

 

ActiveView Property

Description

The RepositoryName of the active View, as represented by the active Aggregate Category link.

Syntax

object.ActiveView

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the ActiveView property to return the
'repository name of the active View, and then writes this information to
'the run results.

var_ActiveView = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").ActiveView
Reporter.ReportEvent 2, "ActiveView for SiebPageTabs object  ", " returns:  " & var_ActiveView

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

                    'The following example uses the UIName and ClassName properties to display this
'information for all child objects of the Siebel Call Center application.

'Retrieve all the children of the siebel application object
Set MyDescription = Description.Create()
Set MyChildren = SiebApplication("Siebel Call Center").ChildObjects(MyDescription)
childCount = MyChildren.Count
'Display the UI names and classes for each object.
For i = 0 To childCount - 1
    MsgBox MyChildren(i).UIName + "  object of class   " + MyChildren(i).ClassName
Next

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

                    'The following example uses the Count property to return the number of
'items in a PageTab object, and then writes this information to the run results.

var_count = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").Count
Reporter.ReportEvent 2, "Count for SiebPageTabs items  ", " returns:  " & var_count

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

 

ScreenCount Property

Description

The number of screen objects that are present in the current context.

Syntax

object.ScreenCount

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the ScreenCount property to return the number of
'Screen objects present, and then writes this information to the run results.

var_ScreenCount = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").ScreenCount
Reporter.ReportEvent 2, "ScreenCount for SiebPageTabs object  ", " returns:  " & var_ScreenCount

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

                    'The following example finds all the objects in the Daily Calendar with the same
'classname as a specified SiebPickList object and then displays the Repository
'name of each of these objects.

Set MyDescription = Description.Create()
MyDescription("classname").Value = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").SiebPicklist("SiebPicklist").ClassName
Set MyChildren = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").ChildObjects(MyDescription)
childCount = MyChildren.Count
' now we show test object names
For i = 0 To childCount - 1
        MsgBox MyChildren(i).RepositoryName
Next

Back to top

 

ViewCount Property

Description

The number of view objects that are present in the current context.

Syntax

object.ViewCount

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the ViewCount property to return the number of
'View objects present, and then writes this information to the run results.

var_ViewCount = SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").ViewCount
Reporter.ReportEvent 2, "ViewCount  for SiebPageTabs object   ", " returns:  " & var_ViewCount

Back to top

See also: