SiebRichText Object

Description

A rich text control 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 SiebRichText object.

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

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.
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.
Method SetTextEnters text in the text area.
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 ClassNameThe class of the object.
Common Property ExistChecks whether the object currently exists in the open application.
Property IsEnabledIndicates whether the object is enabled.
Property IsRequiredIndicates whether the object is required.
Property RepositoryNameThe name of the object as it is stored in the repository.
Property TextThe text value of the object.
Property UINameThe name of the object as it appears in the user interface.

Back to top

 

SetText Method

Description

Enters text in the text area.

Syntax

object.SetText (Text)

Arguments

ParameterDescription
Text Required. A String value.
The text to enter.

Return Type

None.

Example

                    'The following example uses the SetText method to enter text in a text box
'after ensuring that the text box is enabled.

var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Projects").SiebView("Project Notes").SiebApplet("Note Detail").SiebRichText("Description").IsEnabled
If var_IsEnabled Then
    SiebApplication("Siebel Call Center").SiebScreen("Projects").SiebView("Project Notes").SiebApplet("Note Detail").SiebRichText("Description").SetText "My Opportunity"
End If

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

 

IsEnabled Property

Description

Indicates whether the object is enabled.

Syntax

object.IsEnabled

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the IsEnabled property to ensure that the
'"Description" text box is enabled before entering text in the text box.

var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Projects").SiebView("Project Notes").SiebApplet("Note Detail").SiebRichText("Description").IsEnabled
If var_IsEnabled Then
    SiebApplication("Siebel Call Center").SiebScreen("Projects").SiebView("Project Notes").SiebApplet("Note Detail").SiebRichText("Description").SetText "My Opportunity"
End If

Back to top

 

IsRequired Property

Description

Indicates whether the object is required.

Syntax

object.IsRequired

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the IsRequired property to check whether the
'"Description" text box is set as a required field and then attempts to
'enter an empty string in the text box. The example then confirms that a
'warning message opens when submitting an empty string in the required field.

var_IsRequired = SiebApplication("Siebel Call Center").SiebScreen("Projects").SiebView("Project Notes").SiebApplet("Note Detail").SiebRichText("Description").IsRequired
SiebApplication("Siebel Call Center").SiebScreen("Projects").SiebView("Project Notes").SiebApplet("Note Detail").SiebRichText("Description").SetText ""
SiebApplication("Siebel Call Center").SiebScreen("Projects").SiebView("Project Notes").SiebApplet("Note Detail").SiebButton("New").Click
var_Exist = Browser("Siebel Call Center").Dialog("Siebel").Exist
If (var_IsRequired And var_Exist) Then
    Reporter.ReportEvent 0, "SiebText object   ", "behaves as expected for a required field."
Else
   Reporter.ReportEvent 1, "SiebText object   ", "does not behave properly as a required field."
End If
Browser("Siebel Call Center").Dialog("Siebel").WinButton("OK").Click

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.

Property type

Read-only property

Example

                    'The following example uses the Text property to confirm that the
'"Description" text box contains the expected text value.

var_Text = SiebApplication("Siebel Call Center").SiebScreen("Projects").SiebView("Project Notes").SiebApplet("Note Detail").SiebRichText("Description").Text
If var_Text = "My Opportunity" Then
    Reporter.ReportEvent 0, "SiebText object, 'text' property  ", "Returns expected value."
Else
   Reporter.ReportEvent 1, "SiebText object, 'text' property  ", "Does not return expected value."
End If

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

See also: