17.6 Visual Keywords

PasteTextOnEditBox

This keyword will copy the text from clipboard and paste it on an EditBox object. It takes an EditBox object as Object input argument. This keyword is mostly used in situations where you want to copy any text from the clipboard and paste it on the EditBox.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

In the above screenshot, if you want to Copy the Text “Williams” from the clipboard to the highlighted Edit Box object then here is how you will use this keyword:

PasteTextOnEditBox

Fetch the Edit Box Object “Username” and then capture its image by clicking on the

icon. Save the Image property of the object and set its Tolerance Property. Check the Is Used checkbox only for Image and Tolerance property.

Click Save.
Note: You can also fetch objects by adding them manually.
Open Notepad [clipboard] and write the content which you wish to copy on the edit box object. Press Ctrl + C and run the keyword.

Common Error conditions

DragDrop

This keyword will drag the first object onto the second object. It takes two objects as Object Input arguments.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let the first object be Drag whose properties are fetched as follows:

Let the second object be Drop whose properties are fetched as follows:

Suppose you want to drag the first object onto the second object .Here is how you will use DragDrop keyword:

DragDrop

Common Error conditions

DoubleClick

This keyword will double click on the specified object. It takes one object as Object Input arguments. It does not take any data Input Argument.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Suppose you want to double click on the object Obj1 . Here is how you will use DoubleClick keyword:

DoubleClick

Common Error conditions

SetImageUpScaleFactor

This keyword will find the ReferenceImage on the screen after trying (many) up-scaled versions of the ReferenceImage. This helps in scenarios when the zoom(or resolution) level of the AUT has changed from the original OR Object.

This keyword also remembers the scaling-factor and applies it to all further keywords of the same session until the ResetImageScaleFactor keyword is called. This keyword returns the scaling factor of the source Image wrt the Screen Image.

It takes one image object as Object Input arguments. It does not take any data Input Argument.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Features whose properties are fetched as follows:

Suppose you have to run this keyword on Chrome where you have Zoomed the screen from 100% to 110%. In this case, SetImageUpScaleFactor keyword will up-scale the image 10% in order to match the object.

Here is how you will use SetImageUpScaleFactor keyword:

SetImageUpScaleFactor

Common Error conditions

WaitForObjectAppearance

This keyword will wait for the specified time till the specified object appears on the screen. It takes one object as Object Input arguments. It also takes TimeOutInSeconds as data Input Argument.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Suppose object Obj1 appears on the screen after hovering the mouse over the highlighted object [wrt to the screenshot below] .

Here is how you will use WaitForObjectAppearance keyword:

WaitForObjectAppearance

Common Error conditions

WaitForObjectDisAppearance

This keyword will wait for the specified time till the specified object disappears on the screen. It takes one object as Object Input arguments. It also takes TimeOutInSeconds as data Input Argument.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Suppose object Obj1 disappears on the screen after hovering the mouse over the highlighted object [wrt to the screenshot below] .

Here is how you will use WaitForObjectDisAppearance keyword:

WaitForObjectDisAppearance

Common Error conditions

SetImageDownScaleFactor

This keyword will find the ReferenceImage on the screen after trying (many) Down-scaled versions of the ReferenceImage. This helps in scenarios when the zoom(or resolution) level of the AUT has changed from the original OR Object.

It takes one image object as Object Input arguments. It does not take any data Input Argument.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Features whose properties are fetched as follows:

Suppose you have to run this keyword on Chrome where you have Zoomed the screen from 100% to 80%. In this case, SetImageDownScaleFactor keyword will Down-scale the image 10% in order to match the object.

Here is how you will use SetImageDownScaleFactor keyword:

SetImageDownScaleFactor

Common Error conditions

Rightclick

This keyword will right click on the specified object. It takes one object as Object Input arguments. It does not take any data Input Argument.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Suppose you want to right click on the object. Here is how you will use RightClick keyword:

RightClick

Common Error conditions

Click

This keyword will click on the specified object. It takes one object as Object Input arguments. It does not take any data Input Argument.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Suppose you want to click on the object Obj1 . Here is how you will use Click keyword:

Click

Common Error conditions

ResetImageScaleFactor

This keyword will Reset the Image Scale Factor to 1.0. It does not take any Object or data Input Argument.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Features whose properties are fetched as follows:

Suppose you have to run this keyword SetImageDownScaleFactor on Chrome where you have Zoomed Out the screen from 100% to 80%. In this case, If you want Reset the image back to original, then here is you can use ReSetImageScaleFactor keyword which will Reset the Image Scale Factor to 1.0.

Common Error conditions

There are no error conditions for this keyword.

‍

Hover

This keyword will hover the mouse on the specified object. It takes one object as Object Input arguments. It does not take any data Input Argument.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Suppose you want to hover the mouse on the object Obj1. Here is how you will use Hover keyword:

Hover

Common Error conditions

TypeTextOnEditBox

This keyword will Type the specified text on an Editbox object. It takes an Editbox object as Object input argument and Text to be typed as Data Input Argument.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

In the above screenshot, if you want to Type the Text “Williams” to the highlighted Edit box object then here is how you will use this keyword:

TypeTextOnEditBox

Fetch the Edit Box Object “Username” and then capture its image by clicking on the

icon. Save the Image property of the object and set its Tolerance Property. Check the Is Used checkbox only for Image and Tolerance property.

Click Save.
Note: You can also fetch objects by adding them manually.

Common Error conditions

CompareImageObjects

This keyword shall try to compare the two image objects and return True if either of the image is found similar to the other one. It takes two image objects as Object Input arguments.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Let there be an object Obj2 whose properties are fetched as follows:

Suppose, you want to compare object Obj1 and Obj2 then, here is how you will use CompareImageObjects keyword:

CompareImageObjects

Common Error conditions

VerifyObjectExists

This keyword will verifies the existence of an object through an image. It takes one object as Object Input arguments.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Suppose You wish to verify the existence of this object then, here is how you will use VerifyObjectExists keyword:

VerifyObjectExists

Common Error conditions

CompareImages

This keyword will compare the two images and return True if either of the image is found on the other one.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Suppose you want to compare two images then,here is how you will use CompareImages keyword:

CompareImages

Common Error conditions

CountAllMatchingObjects

This keyword will return the number of matching objects on the screen. It takes one object as Object Input arguments.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Suppose You wish to calculate the number of matching objects on the screen. then, here is how you will use CountAllMatchingObjects keyword:

CountAllMatchingObjects

Output : 7

Common Error conditions

ReadTextFromImagePath

This keyword will apply OCR [optical character recognition] techniques to read Text from the specified Image. It takes Image Path as Data Input arguments.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Suppose You wish to fetch the Text of the Image, then, here is how you will use ReadTextFromImagePath keyword:

ReadTextFromImagePath

Note: The image should be in the jpg format.

Output:

Settings

Common Error conditions

OverlayImagesObjectBased

This keyword will splits two image into multiple small Images, compares each small Image and check for the mismatches based on the Object and Data Input Arguments provided.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Let there be an Object Obj2 whose properties are as follows:

Suppose You wish to splits two images into multiple small Images, compares each small Image and check for the mismatches, then here is how you will use OverlayImages_ObjectBased keyword:

OverlayImages_ObjectBased

When the Should Overlay Images is “False” then the screenshot will be as follows:

When the Should Overlay Images is “True” then the screenshot will be as follows:

Output

Common Error conditions

OverlayImages

This keyword will splits two images into multiple small Images, compares each small Image and check for the mismatches based on the Object and Data Input Arguments provided.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Suppose You wish to splits two images into multiple small Images, compares each small Image and check for the mismatches, then here is how you will use OverlayImages keyword:

OverlayImages

When the Should Overlay Images is “False” then the screenshot will be as follows:

When the Should Overlay Images is “True” then the screenshot will be as follows:

Output

Common Error conditions

ReadTextFromScreenCoordinates

This keyword will apply OCR [optical character recognition] techniques to read Text from the specified coordinates of the Screen based on the Data Input Arguments provided.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let the screen be as follows:

Suppose You wish to read the Text displayed on the screen, then, here is how you will use ReadTextFromScreenCoordinates keyword:

ReadTextFromScreenCoordinates

Output:

Upcoming Movies in 2018

Common Error conditions

FindMatchingObjects

This keyword will find a matching object through an image on the screen. It takes one object as Object Input arguments.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an object Obj1 whose properties are fetched as follows:

Suppose You wish to find a matching objects on the screen. then, here is how you will use FindMatchingObjects keyword:

FindMatchingObjects

Common Error conditions

ReadTextFromScreen

This keyword will apply OCR [optical character recognition] techniques to read Text from the whole Screen. It does not take any Data or Object Input arguments.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let the screen be as follows:

Suppose You wish to read the Text displayed on the screen, then you can use ReadTextFromScreen keyword:

Output:

Upcoming Movies in 2018

Common Error conditions

There are no error conditions for this keyword.

‍

ReadTextFromImage

This keyword will apply OCR [optical character recognition] techniques to read Text from the specified Image. It takes an Image Object as Object Input arguments.

Note: Sikuli Specific keywords works on the image and tolerance property of the object and are used for image based testing.

Input Arguments

Output

Example

Let there be an Object Obj1 which has the following properties:

The Tolerance Property of the Selected Image Object is set as 0.7 so that the Text of the image can be easily read.

Suppose You wish to fetch the Text of the Image [Img.jpg], then, here is how you will use ReadTextFromImage Keyword

ReadTextFromImage

Note:

The image should be in the jpg format.

Output:

Error Message