Object Model Reference for GUI Testing > Siebel > Click Method

SiebCommunicationsToolbar Object

Description

The communications toolbar 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 SiebCommunicationsToolbar object.

Note: You can also view a list and descriptions of the SiebCommunicationsToolbar 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 Click Clicks the specified button.
Method GetButtonState Returns a String that The state of the specified button (for example, Blinking).
Method GetButtonTooltip Returns a String that The tooltip for the specified button.
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.
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.
Method SelectWorkItem Selects the specified work item.
Method SetText Enters text in the textbox.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method ShowButtonTooltip Displays the tooltip for the specified button.
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 ClassName The class of the object.
Property CurrentWorkItem The currently selected work item.
Common Property Exist Checks whether the object currently exists in the open application.
Property IsEnabled Indicates whether the object is enabled.
Property IsVisible Indicates whether the object is visible.
Property MediaType The type of media.
Property Message The communication channel information displayed next to the Siebel menu that indicates where the message comes from (for example, Call Display).
Property RepositoryName The name of the object as it is stored in the repository.
Property Text The text value of the object.
Property UIName The name of the object as it appears in the user interface.
Property WorkItemDuration The duration of the currently selected work item.

 

Back to top

Click Method

Description

Clicks the specified button.

Syntax

object.Click (ButtonName)

Arguments

Parameter Description
ButtonName Required. A String value.
The RepositoryName of the button.

Return Type

None.

Example


 

Back to top

GetButtonState Method

Description

Returns a String that The state of the specified button (for example, Blinking).

Syntax

object.GetButtonState (ButtonName)

Arguments

Parameter Description
ButtonName Required. A String value.
The RepositoryName of the button.

Return Type

A String value.

The state of the specified button (for example, Blinking).

Example


 

Back to top

GetButtonTooltip Method

Description

Returns a String that The tooltip for the specified button.

Syntax

object.GetButtonTooltip (ButtonName)

Arguments

Parameter Description
ButtonName Required. A String value.
The RepositoryName of the button.

Return Type

A String value.

The tooltip for the specified button.

Example


 

Back to top

SelectWorkItem Method

Description

Selects the specified work item.

Syntax

object.SelectWorkItem (Item)

Arguments

Parameter Description
Item Required. A long integer value.
The WorkItem to select.

Return Type

None.

Example


 

Back to top

SetText Method

Description

Enters text in the textbox.

Syntax

object.SetText (Text)

Arguments

Parameter Description
Text Required. A String value.
The text to enter.

Return Type

None.

Example


 

Back to top

ShowButtonTooltip Method

Description

Displays the tooltip for the specified button.

Syntax

object.ShowButtonTooltip (ButtonName)

Arguments

Parameter Description
ButtonName Required. A String value.
The RepositoryName of the button.

Return Type

None.

IMPORTANT

This event is significant because the CommunicationsToolbar tooltip is dynamic, causing a roundtrip to the server.

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

CurrentWorkItem Property

Description

The currently selected work item.

Syntax

object.CurrentWorkItem

Value Type

A String 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

IsVisible Property

Description

Indicates whether the object is visible.

Syntax

object.IsVisible

Value Type

A long integer value.

Property type

Read-only property

IMPORTANT

You cannot checkpoint this property because the control is not rendered by the browser when it is not visible. However, you can manually write script code to check the property.

Example


 

Back to top

MediaType Property

Description

The type of media.

Syntax

object.MediaType

Value Type

A String value.

Property type

Read-only property

Example


 

Back to top

Message Property

Description

The communication channel information displayed next to the Siebel menu that indicates where the message comes from (for example, Call Display).

Syntax

object.Message

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

Text Property

Description

The text value of the object.

Syntax

object.Text

Value Type

A String value.

The RepositoryName of the toolbar.

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


 

Back to top

WorkItemDuration Property

Description

The duration of the currently selected work item.

Syntax

object.WorkItemDuration

Value Type

A String value.

Property type

Read-only property

Example


Back to top

See also: