VisualRelationsCollection Object

A 0-based collection of VisualRelation Object that together comprise the visual relation identifier element of a test object.

IMPORTANT

• You can retrieve the collection representing the existing visual relations identifier for a test object, using the syntax:

  SetVRIColl = TestObject.GetTOProperty("visual relations")

  You can also create a new VisualRelationsCollection object using Create Method or Clone Method statements.

• After you create or modify a VisualRelationsCollection object, you can apply it to a test object using the syntax:

  TestObject.SetTOProperty "visual relations", VRIColl

  When the SetTOProperty step runs, it replaces any existing visual relation identifier definitions for the run-time test object with those defined in the specified VisualRelationsCollection object.

• Alternatively, you can apply the definitions in a VisualRelationsCollection to a test object using a Description Object. For example:

  Set VisualRel = VisualRelations.Create
  '...Add relations to the VisualRel collection 
  
  Set MyDesc = Description.Create
  MyDesc("nativeclass").Value = "Button"
  MyDesc("visual relations").Value = VisualRel 
  
  ParentObject("ObjName").SomeTestObject(MyDesc).Click
  

Methods and Properties

Add	Adds a new VisualRelation Object to the collection.
Clone	Creates a copy of the VisualRelationsCollection.
Count	Returns the number of VisualRelation objects in the collection.
Item	Returns the VisualRelation Object located in the specified position.
Remove	Removes the VisualRelation Object located in the specified location from the collection.

Back to top

Add Method

Description

Adds a new VisualRelation Object to the collection.

Syntax

SetVRel = VRIColl.Add

Return Value

The created VisualRelation Object.

Example

The following example demonstrates the use of a VisualRelations collection with a test object that has an ambiguous programmatic description. The same test object is used to represent different buttons in the calculator application based on the relative position of the buttons to the left and right of that button. Using these settings, the example below clicks on buttons 2, 5, and 8 in the calculator. (The example assumes that all objects from the calculator application have been added to the object repository.)

For i = 2 to 8 step 3
    print "Now selecting the object that matches button " & i & " via the related buttons " & (i-1) & " and " & (i+1)

    'Define an ambiguous button object on the calculator.
    Set obj = Window("text:=Calculator").WinButton("text:=.*")

    'Define two visual relations for the current button.
    Set rc = VisualRelations.Create
    Set relation = rc.Add
    relation.relatedobjectpath = "Window(""Calculator"").WinButton(""" & (i-1) & """)"
    relation.relativeposition = micRelLeft
    relation.setargument micrelinline, True
    Set relation = Nothing
    set relation = rc.Add
    relation.relatedobjectpath = "Window(""Calculator"").WinButton(""" & (i+1) & """)"
    relation.relativeposition = micRelRight
    relation.setargument micrelinline, True
    Set relation = Nothing

    'Update the defined test object with the new visual relation identifier.
    obj.SetTOProperty "visual relations", rc
    obj.Click

    'Release the objects
    Set rc = Nothing
    Set obj = Nothing
Next

Back to top

Clone Method

Description

Creates a copy of the VisualRelationsCollection.

Syntax

SetVRIColl_Copy = VRIColl.Clone

Return Value

The new (copy of the) VisualRelationsCollection Object.

Example

In this example, coll is an instance of a VisualRelationsCollection object.

set cloned = coll.Clone

Back to top

Count Property

Description

The number of VisualRelation objects in the collection.

Syntax

VRIColl.Count

Return Value

Read-only. A number.

Example

In this example, coll is an instance of a VisualRelationsCollection object.

coll.Add
For i = 0 To coll.Count-1 Step 1
	coll.Item(0).relatedobjectpath = "Window(""Calculator"").WinButton("""& i &""")"
	coll.Item(0).relativeposition = micRelLeft
	coll.Item(0).setargument micrelinline, True
Next

Back to top

Item Property

Description

Returns the VisualRelation Object located in the specified position.

Syntax

Set VRIObj = VRIColl.Item

Return Value

Read-only. A VisualRelation Object.

Example

In this example, coll is an instance of a VisualRelationsCollection object.

coll.Add

For i = 0 To coll.Count-1 Step 1

coll.Item(0).relatedobjectpath = "Window(""Calculator"").WinButton("""& i &""")"

coll.Item(0).relativeposition = micRelLeft

coll.Item(0).setargument micrelinline, True

Next

Back to top

Remove Method

Description

Removes the VisualRelation Object located in the specified location from the collection.

Syntax

VRIColl.Remove ItemIndex

Example

In this example, 'coll is an instance of a VisualRelationsCollection object.

While coll.Count > 0
	coll.remove(0)
Wend

Back to top

RemoveAll Method

Description

Removes all VisualRelation objects from the collection.

Syntax

VRIColl.RemoveAll

Example

In this example coll is an instance of a VisualRelationsCollection object.

coll.RemoveAll

Back to top

See also:

• Crypt Object
• DataTable Object
• Description Object
• DeviceReplay Object
• DotNetFactory Object
• DTParameter Object
• DTSheet Object
• Environment Object
• Extern Object
• Parameter Object
• JSON Object
• JsonUtil Object
• MercuryTimers Object (Collection)
• MercuryTimer Object
• NV Object
• OptionalStep Object
• ParallelUtil Object
• LocalParameter Object
• PasswordUtil Object
• PathFinder Object
• PDFUtil Object
• Properties Object (Collection)
• QCUtil Object
• RandomNumber Object
• Recovery Object
• Remote Connection Object
• Reporter Object
• RepositoriesCollection Object
• Repository Object
• Services Object
• Setting Object
• SystemMonitor Object
• TestArgs Object
• TextUtil Object
• UIAutomation Object
• VisualRelation Object
• VisualRelations Object
• VisualRelationsCollection Object
• WebUtil Object
• XMLUtil Object