Selenium GenericObjectFunctions

Last Updated:

Actions for working with GENERIC objects



[How To Read This Reference]
AltClick
SE2
A ALT-click on an object.
AltLeftDrag
SE2
An ALT left mouse drag is performed on the object based on the stored coordinates.
Click
TID SE SE2
A single click on an object.
ClickScreenImage
TID
Same as Click.
ClickScreenLocation
TID
Click a specified screen location.
ClickScreenPoint
TID
Deprecated For:GenericObject ClickScreenLocation
CtrlAltLeftDrag
SE2
CTRL ALT left mouse drag is performed on the object based on the stored coordinates.
CtrlClick
TID SE SE2
A CTRL-click on an object.
CtrlClickScreenImage
TID
Same as CtrlClick.
CtrlLeftDrag
SE2
A CTRL left mouse drag is performed on the object based on the stored coordinates.
CtrlRightClick
TID SE SE2
A CTRL-Right click on an object.
CtrlRightClickScreenImage
TID
Same as CtrlRightClick.
CtrlShiftLeftDrag
SE2
A CTRL SHIFT left mouse drag is performed on the object based on the stored coordinates.
DoubleClick
TID SE SE2
A double click on an object.
DoubleClickScreenImage
TID
Same as DoubleClick.
DoubleClickScreenLocation
TID
DoubleClick a specified screen location.
DoubleClickScreenPoint
TID
Deprecated For:GenericObject DoubleClickScreenLocation
DragTo
SE2
A left mouse drag is performed from one object to another object based on the offsets values.
LeftDrag
TID SE2
A left mouse drag is performed on the object based on the stored coordinates.
MultiClick
TID
Multiple clicks on an object.
MultiClickScreenImage
TID
Same as MULTICLICK.
RightClick
TID SE SE2
A right click on an object.
RightClickScreenImage
TID
Same as RightClick.
RightClickScreenLocation
TID
RightClick a specified screen location.
RightClickScreenPoint
TID
Deprecated For:GenericObject RightClickScreenLocation
RightDrag
TID SE2
A right mouse drag is performed on the object based on the stored coordinates.
ShiftClick
TID SE SE2
A SHIFT click on an object.
ShiftClickScreenImage
TID
Same as ShiftClick.
ShiftLeftDrag
SE2
A SHIFT left mouse drag is performed on the object based on the stored coordinates.

Selenium GenericObjectFunctions::AltClick
SE2

A ALT-click on an object.

By default we should click the center of the object.

We can also ALT-click on any part of an object based on a stored x,y coordinate. The object containing the coordinate is first given context and then a ALT-click is generated at the coordinate. Thus, an item or object can be referenced by name even though it is only recognized via coordinates.

The coordinate lookup is done with the component name of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow MainWindow AltClick
(2) t MainWindow MainWindow AltClick AnObject
(3) t MainWindow ToolItem AltClick PrintTool

#2 above will contain an AnObject="3,10" entry in the MainWindow section of the Application Map to ALT-click at x=3, y=10 in the MainWindow. For SE+, the coordinate can be percentage format, like "20%,30%". This percentage format indicates the point (20% width of component, 30% height of component) relative to the object.

#3 above will contain a ToolItem entry in the MainWindow section with normal recognition information for it . ToolItem will also have it's own section in the Application Map in which there will be an entry like PrintTool="15,30". This will tell Robot to locate the PrintTool Window object and ALT-click at the coordinates specified by the reference.

Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

  • "," (comma) Example: "50,200"
  • ";" (semi-colon) Example: "50;200"
  • " " (space) Example: "50 200"



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Optional) Name of the AppMap subkey to lookup and use for the ALT-click.

    Without this we should click the center of the object.

    Name of the AppMap subkey to lookup and use for the ALT-click. We expect the AppMap to contain the item in the format "x,y":

                    [ToolItem]
                    PrintTool="33,120"      OR
                    PrintTool="Coords=33,120"
                    

    The results from the lookup are appended to the "Coords=" string used by the GenericObject Alt_Click command in Robot (if necessary). So any valid content used with the Alt_Click command can be part of this AppMap entry.

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

    • "," (comma) Example: "50,200"
    • ";" (semi-colon) Example: "50;200"
    • " " (space) Example: "50 200"

    Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).



  2. [ AutoScroll = ]
    (Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.

    If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
    If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

    NOTE:
    SE2 : For now, this optional parameter is only supported in Selenium2.0 Engine.

Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::AltLeftDrag
SE2

An ALT left mouse drag is performed on the object based on the stored coordinates.

The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow GenericItem AltLeftDrag DragName

#1 above will contain a GenericItem entry in the MainWindow section with normal recognition information for it . GenericItem will also have it's own section in the Application Map in which there will be an entry like:

DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"

This will tell RFT to locate the GenericItem Window object and an ALT left mouse drag from coordinates 15,30 to 60,90.



Fields: [ ]=Optional with Default Value
  1. AppMapSubkey
    Name of the AppMap subkey to lookup or literal text to use for an ALT left mouse drag.

    Name of the AppMap subkey to lookup and use for an ALT left mouse drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

                      [GenericItem]
                      DragName="3,10,12,20"     OR
                      DragName="Coords=3,10,12,20"
                      

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::Click
TID SE SE2

A single click on an object.

By default, clicks on the center of the component. We can also click on any part of an object, or any point relative to an object based on a provided x,y coordinate or other component-specific parameters.

For SE+, the coordinate can be percentage format, like "20%,30%". This percentage format indicates the point (20% width of component, 30% height of component) relative to the object.

The object to be clicked is first given context and then a click is generated at the coordinates. Thus, a subitem or object can be referenced by name even though it is only recognized via coordinates.

The coordinate lookup is done with the component name of the record AND Field #5 or by providing the literal text of the coordinates, where supported.

Typical Data Table records:

(1) t MainWindow MainWindow Click
(2) t MainWindow MainWindow Click AnObject
(3) t MainWindow FolderTree Click Node1
(4) t MainWindow MainWindow Click "50,200"
(5) t MainWindow MainWindow Click "Coords=50,200"

For SE+, the Data Table records can be:

(6) t MainWindow MainWindow Click "50%,20%"
(7) t MainWindow MainWindow Click "50,20%"

#2 above will contain an AnObject="3,10" entry in the MainWindow section of the Application Map to click at x=3, y=10 in the MainWindow.

#3 above will contain a FolderTree entry in the MainWindow section with normal recognition information for it. FolderTree will also have it's own section in the Application Map in which there will be an entry like Node1="15,30". This will tell Robot to locate the FolderTree Generic object and click at the coordinates specified by the reference.

#4 and #5 above show using literal text instead of an App Map entry to specify where to click relative to the item.

#6 and #7 above show using percentage format in SE+. #6 will click at position, where the X value equals 50% width of component, its Y value equals 20% height of component, relative to the object. #7 will click at position, where the X value equals 50, its Y value equals 20% height of component, relative to the object.

Rational Robot no longer requires the AppMapSubKey be provided and will attempt to use the string as literal text if no AppMapSubKey is found in the current App Map. Robot also no longer assumes the AppMapSubKey value or the literal value is presenting coordinate information. This allows components that can accept parameters other than coordinates, like table row/col values or ImageMap areas to be specified.

If the value is deduced to contain coordinates, but is not prefixed with "Coords=" text, then Robot will add the prefix. Otherwise, the text value will remain unmodified.

This is the direction we expect all tools to follow going forward.

Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

  • "," (comma) Example: "50,200"
  • ";" (semi-colon) Example: "50;200"
  • " " (space) Example: "50 200"

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.

For IOS: Any optional coordinates MUST be specified as an integer number between 0-100. 0 represents the extreme left (or top), while 100 represents the extreme right (or bottom). IOS does not use absolute coordinates, but relative coordinates representing a percentage of the element width or height.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Optional)Name of the AppMap subkey to lookup or the literal text to use for the click.

    Without this we should click on the center of the object.

    Name of the AppMap subkey to lookup and use for the click. We expect the AppMap or literal text to contain the item in the format "x,y":

                    [FolderTree]
                    Node1="33,120"      OR
                    Node1="Coords=33,120"
                    ...
                    [AnHTMLImage]
                    AMappdedRegion=Coords=10,10
                    ANamedRegion=AreaName=TechSupport
                    AnIndexedRegion=AreaIndex=2
                    AnotherRegion=AreaID=Contact
                    

    The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (only if necessary). So any valid content used with the Click command can be part of this AppMap entry.

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    The Rational Robot implementation also supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.

    Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

    • "," (comma) Example: "50,200"
    • ";" (semi-colon) Example: "50;200"
    • " " (space) Example: "50 200"

    Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.

    Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.

    Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).

    For IOS: Any optional coordinates MUST be specified as an integer number between 0-100. 0 represents the extreme left (or top), while 100 represents the extreme right (or bottom). IOS does not use absolute coordinates, but relative coordinates representing a percentage of the element width or height.



  2. [ AutoScroll = ]
    (Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.

    If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
    If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

    NOTE:
    SE2 : For now, this optional parameter is only supported in Selenium2.0 Engine.

Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::ClickScreenImage
TID

Same as Click.

The keyword is simply provided as a means to differentiate Object-Based Testing from Image-Based Testing in your tests. However, this differentiation is not required.

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubKey = ]
    (Optional) AppMapSubKey type of use as documented in the CLICK command.


Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::ClickScreenLocation
TID

Click a specified screen location.

Click a specified screen location.

We can click on any screen location based on stored x,y coordinates or hardcoded literal values. The Window:Component fields can be anything at all and will be ignored if they do not exist in the app map, or if the retrieved app map data does not contain coordinate data. Thus, an item or object can be referenced by name even though it is only known via coordinates.

If the Window:Component AppMap lookup does NOT contain coordinate data and is ignored, then the AppMapSubKey field is REQUIRED and is expected to contain a reference or literal text containing absolute screen coordinates.

If the Window:Component AppMap lookup DOES contain coordinate data, this data is treated as the absolute screen coordinates to be used. The AppMapSubKey field becomes OPTIONAL and coordinate data in the field is treated as a relative offset added to the absolute values found for the Window:Component.

Any AppMapSubKey lookup is done with the Component name in the record AND Field #5.

Typical Data Table records:

(1) t MainWindow Component ClickScreenLocation
(2) t MainWindow MainWindow ClickScreenLocation AnObject
(3) t MainWindow MainWindow ClickScreenLocation 50,80
(4) t AnyWin AnyComp ClickScreenLocation Node1

#1 above will contain a blank as it's 5th field. Because the AppMapSubKey field is blank, the [MainWindow] section of the AppMap MUST have a Component item with valid absolute screen coordinates for the click.

#2 above will contain an AnObject="Coords=50,80" entry in the [MainWindow] section of the AppMap. If there is a MainWindow component in the AppMap with valid screen coordinates then the click will occur with a relative offset of 50,80 from those absolute screen coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.

#3 If there is a MainWindow component in the [MainWindow] section of the AppMap with valid screen coordinates then the click will occur with a relative offset of 50,80 from those absolute screen coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.

#4 above will contain no valid AnyWin:AnyComp coordinate data and those fields will be ignored. However, Node1 MUST exist in the Application Map [AnyComp] section to provide absolute screen coordinates for the click.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Sometimes Optional)Name of the AppMap subkey to locate in the AppMap.

    Without this there MUST be absolute screen coordinates stored in the AppMap for the Window:Component specified.

    Name of the AppMap subkey to locate in the App Map. We expect the AppMap to contain the coordinates in the following supported formats:

                    [Component]
                    Node1="33,120"        (comma-delimited)      OR
                    Node1="33;120"        (semi-colon delimited) OR
                    Node1="33 120"        (space-delimited)      OR
                    Node1="Coords=33,120" (comma-delimited)      OR
                    Node1="Coords=33;120" (semi-colon delimited) OR
                    Node1="Coords=33 120" (space-delimited)
                    

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    This field can instead contain the literal text of any absolute or relative coordinates in the same formats as shown above.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::ClickScreenPoint (deprecated for: GenericObject ClickScreenLocation)
TID

(Deprecated) Click a specified screen location.

(Deprecated) Click a specified screen location. See ClickScreenLocation for the preferred method to click on screen coordinates.

We can click on any screen location based on literal text x,y coordinates retrieved from Field #5. Window and Component names and App Map entries are completely ignored. So the user can put anything in those fields that might help test readability.

It is not recommended to hardcode screen coordinates in the test table in this way.



Fields: [ ]=Optional with Default Value
  1. Coords
    The hardcoded X,Y screen coordinates--or the result of an expression--that provides the absolute screen coordinates to click.

    The coordinates must be in the following supported formats:

                    "33,120"        (comma-delimited)      OR
                    "33;120"        (semi-colon delimited) OR
                    "33 120"        (space-delimited)
                    

    Note the "Coords=" prefix is NOT supported for this deprecated command.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::CtrlAltLeftDrag
SE2

CTRL ALT left mouse drag is performed on the object based on the stored coordinates.

The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow GenericItem CtrlAltLeftDrag DragName

#1 above will contain a GenericItem entry in the MainWindow section with normal recognition information for it . GenericItem will also have it's own section in the Application Map in which there will be an entry like:

DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"

This will tell RFT to locate the GenericItem Window object and CTRL ALT left mouse drag from coordinates 15,30 to 60,90.



Fields: [ ]=Optional with Default Value
  1. AppMapSubkey
    Name of the AppMap subkey to lookup or literal text to use for the CTRL ALT left mouse drag.

    Name of the AppMap subkey to lookup and use for the CTRL ALT left mouse drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

                      [GenericItem]
                      DragName="3,10,12,20"     OR
                      DragName="Coords=3,10,12,20"
                      

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::CtrlClick
TID SE SE2

A CTRL-click on an object.

By default we should click the center of the object.

We can also CTRL-click on any part of an object based on a stored x,y coordinate. The object containing the coordinate is first given context and then a CTRL-click is generated at the coordinate. Thus, an item or object can be referenced by name even though it is only recognized via coordinates.

The coordinate lookup is done with the component name of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow MainWindow CtrlClick
(2) t MainWindow MainWindow CtrlClick AnObject
(3) t MainWindow ToolItem CtrlClick PrintTool

#2 above will contain an AnObject="3,10" entry in the MainWindow section of the Application Map to CTRL-click at x=3, y=10 in the MainWindow. For SE+, the coordinate can be percentage format, like "20%,30%". This percentage format indicates the point (20% width of component, 30% height of component) relative to the object.

#3 above will contain a ToolItem entry in the MainWindow section with normal recognition information for it . ToolItem will also have it's own section in the Application Map in which there will be an entry like PrintTool="15,30". This will tell Robot to locate the PrintTool Window object and CTRL-click at the coordinates specified by the reference.

Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

  • "," (comma) Example: "50,200"
  • ";" (semi-colon) Example: "50;200"
  • " " (space) Example: "50 200"



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Optional) Name of the AppMap subkey to lookup and use for the CTRL-click.

    Without this we should click the center of the object.

    Name of the AppMap subkey to lookup and use for the CTRL-click. We expect the AppMap to contain the item in the format "x,y":

                    [ToolItem]
                    PrintTool="33,120"      OR
                    PrintTool="Coords=33,120"
                    

    The results from the lookup are appended to the "Coords=" string used by the GenericObject Ctrl_Click command in Robot (if necessary). So any valid content used with the Ctrl_Click command can be part of this AppMap entry.

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

    • "," (comma) Example: "50,200"
    • ";" (semi-colon) Example: "50;200"
    • " " (space) Example: "50 200"

    Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).



  2. [ AutoScroll = ]
    (Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.

    If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
    If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

    NOTE:
    SE2 : For now, this optional parameter is only supported in Selenium2.0 Engine.

Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::CtrlClickScreenImage
TID

Same as CtrlClick.

The keyword is simply provided as a means to differentiate Object-Based Testing from Image-Based Testing in your tests. However, this differentiation is not required.

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubKey = ]
    (Optional) AppMapSubKey type of use as documented in the CLICK command.


Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::CtrlLeftDrag
SE2

A CTRL left mouse drag is performed on the object based on the stored coordinates.

The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow GenericItem CtrlLeftDrag DragName

#1 above will contain a GenericItem entry in the MainWindow section with normal recognition information for it . GenericItem will also have it's own section in the Application Map in which there will be an entry like:

DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"

This will tell RFT to locate the GenericItem Window object and CTRL left drag from coordinates 15,30 to 60,90.



Fields: [ ]=Optional with Default Value
  1. AppMapSubkey
    Name of the AppMap subkey to lookup or literal text to use for the CTRL left mouse drag.

    Name of the AppMap subkey to lookup and use for the CTRL left drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

                      [GenericItem]
                      DragName="3,10,12,20"     OR
                      DragName="Coords=3,10,12,20"
                      

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::CtrlRightClick
TID SE SE2

A CTRL-Right click on an object.

By default we should click the center of the object.

We can also CTRL-Right-Click on any part of an object based on a stored x,y coordinate. The object containing the coordinate is first given context and then a CTRL-Right-Click is generated at the coordinate. Thus, an item or object can be referenced by name even though it is only recognized via coordinates.

The coordinate lookup is done with the component name of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow MainWindow CtrlRightClick
(2) t MainWindow MainWindow CtrlRightClick AnObject
(3) t MainWindow ToolItem CtrlRightClick PrintTool

#2 above will contain an AnObject="3,10" entry in the MainWindow section of the Application Map to CTRL-click at x=3, y=10 in the MainWindow. For SE+, the coordinate can be percentage format, like "20%,30%". This percentage format indicates the point (20% width of component, 30% height of component) relative to the object.

#3 above will contain a ToolItem entry in the MainWindow section with normal recognition information for it . ToolItem will also have it's own section in the Application Map in which there will be an entry like PrintTool="15,30". This will tell Robot to locate the PrintTool Window object and CTRL-Right-Click at the coordinates specified by the reference.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Optional) Name of the AppMap subkey to lookup and use for the CTRL-Right-Click.

    Without this we should click the center of the object.

    Name of the AppMap subkey to lookup and use for the CTRL-Right-Click. We expect the AppMap to contain the item in the format "x,y":

                    [ToolItem]
                    PrintTool="33,120"      OR
                    PrintTool="Coords=33,120"
                    

    The results from the lookup are appended to the "Coords=" string used by the GenericObject CTRL-Right-Click command in Robot (if necessary). So any valid content used with the CTRL-Right-Click command can be part of this AppMap entry.

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



  2. [ AutoScroll = ]
    (Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.

    If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
    If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

    NOTE:
    SE2 : For now, this optional parameter is only supported in Selenium2.0 Engine.

Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::CtrlRightClickScreenImage
TID

Same as CtrlRightClick.

The keyword is simply provided as a means to differentiate Object-Based Testing from Image-Based Testing in your tests. However, this differentiation is not required.

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubKey = ]
    (Optional) AppMapSubKey type of use as documented in the CLICK command.


Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::CtrlShiftLeftDrag
SE2

A CTRL SHIFT left mouse drag is performed on the object based on the stored coordinates.

The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow GenericItem CtrlShiftLeftDrag DragName

#1 above will contain a GenericItem entry in the MainWindow section with normal recognition information for it . GenericItem will also have it's own section in the Application Map in which there will be an entry like:

DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"

This will tell RFT to locate the GenericItem Window object and CTRL SHIFT left mouse drag from coordinates 15,30 to 60,90.



Fields: [ ]=Optional with Default Value
  1. AppMapSubkey
    Name of the AppMap subkey to lookup or literal text to use for the CTRL SHIFT left mouse drag.

    Name of the AppMap subkey to lookup and use for the CTRL SHIFT left mouse drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

                      [GenericItem]
                      DragName="3,10,12,20"     OR
                      DragName="Coords=3,10,12,20"
                      

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::DoubleClick
TID SE SE2

A double click on an object.

By default we should click the center of the object.

We can also double click on any part of an object based on a stored x,y coordinate. The object containing the coordinate is first given context and then a double click is generated at the coordinate. Thus, an item or object can be referenced by name even though it is only recognized via coordinates.

The coordinate lookup is done with the component name of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow MainWindow DoubleClick
(2) t MainWindow MainWindow DoubleClick AnObject
(3) t MainWindow FolderTree DoubleClick Node1

#2 above will contain an AnObject="3,10" entry in the MainWindow section of the Application Map to double click at x=3, y=10 in the MainWindow. For SE+, the coordinate can be percentage format, like "20%,30%". This percentage format indicates the point (20% width of component, 30% height of component) relative to the object.

#3 above will contain a FolderTree entry in the MainWindow section with normal recognition information for it . FolderTree will also have it's own section in the Application Map in which there will be an entry like Node1="15,30". This will tell Robot to locate the FolderTree object and double click at the coordinates specified by the reference.

Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

  • "," (comma) Example: "50,200"
  • ";" (semi-colon) Example: "50;200"
  • " " (space) Example: "50 200"

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.

For IOS: Any optional coordinates MUST be specified as an integer number between 0-100. 0 represents the extreme left (or top), while 100 represents the extreme right (or bottom). IOS does not use absolute coordinates, but relative coordinates representing a percentage of the element width or height.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Optional) Name of the AppMap subkey to lookup or the literal text to use for the double click.

    Without this we should click the center of the object.

    Name of the AppMap subkey to lookup and use for the double click. We expect the AppMap or literal text to contain the item in the format "x,y":

                    [FolderTree]
                    Node1="33,120"      OR
                    Node1="Coords=33,120"
                    

    The results from the lookup are appended to the "Coords=" string used by the GenericObject DBLClick command in Robot (if necessary). So any valid content used with the DBLClick command can be part of this AppMap entry.

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).

    Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

    • "," (comma) Example: "50,200"
    • ";" (semi-colon) Example: "50;200"
    • " " (space) Example: "50 200"

    Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.

    Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.

    For IOS: Any optional coordinates MUST be specified as an integer number between 0-100. 0 represents the extreme left (or top), while 100 represents the extreme right (or bottom). IOS does not use absolute coordinates, but relative coordinates representing a percentage of the element width or height.



  2. [ AutoScroll = ]
    (Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.

    If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
    If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

    NOTE:
    SE2 : For now, this optional parameter is only supported in Selenium2.0 Engine.

Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::DoubleClickScreenImage
TID

Same as DoubleClick.

The keyword is simply provided as a means to differentiate Object-Based Testing from Image-Based Testing in your tests. However, this differentiation is not required.

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubKey = ]
    (Optional) AppMapSubKey as documented in the CLICK command.


Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::DoubleClickScreenLocation
TID

DoubleClick a specified screen location.

DoubleClick a specified screen location.

We can click on any screen location based on stored x,y coordinates or hardcoded literal values. The Window:Component fields can be anything at all and will be ignored if they do not exist in the app map, or if the retrieved app map data does not contain coordinate data. Thus, an item or object can be referenced by name even though it is only known via coordinates.

If the Window:Component AppMap lookup does NOT contain coordinate data and is ignored, then the AppMapSubKey field is REQUIRED and is expected to contain a reference or literal text containing absolute screen coordinates.

If the Window:Component AppMap lookup DOES contain coordinate data, this data is treated as the absolute screen coordinates to be used. The AppMapSubKey field becomes OPTIONAL and coordinate data in the field is treated as a relative offset added to the absolute values found for the Window:Component.

Any AppMapSubKey lookup is done with the Component name in the record AND Field #5.

Typical Data Table records:

(1) t MainWindow Component DoubleClickScreenLocation
(2) t MainWindow MainWindow DoubleClickScreenLocation AnObject
(3) t MainWindow MainWindow DoubleClickScreenLocation 50,80
(4) t AnyWin AnyComp DoubleClickScreenLocation Node1

#1 above will contain a blank as it's 5th field. Because the AppMapSubKey field is blank, the [MainWindow] section of the AppMap MUST have a Component item with valid absolute screen coordinates for the click.

#2 above will contain an AnObject="Coords=50,80" entry in the [MainWindow] section of the AppMap. If there is a MainWindow component in the AppMap with valid screen coordinates then the click will occur with a relative offset of 50,80 from those absolute screen coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.

#3 If there is a MainWindow component in the [MainWindow] section of the AppMap with valid screen coordinates then the click will occur with a relative offset of 50,80 from those absolute screen coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.

#4 above will contain no valid AnyWin:AnyComp coordinate data and those fields will be ignored. However, Node1 MUST exist in the Application Map [AnyComp] section to provide absolute screen coordinates for the click.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Sometimes Optional)Name of the AppMap subkey to locate in the AppMap.

    Without this there MUST be absolute screen coordinates stored in the AppMap for the Window:Component specified.

    Name of the AppMap subkey to locate in the App Map. We expect the AppMap to contain the coordinates in the following supported formats:

                    [Component]
                    Node1="33,120"        (comma-delimited)      OR
                    Node1="33;120"        (semi-colon delimited) OR
                    Node1="33 120"        (space-delimited)      OR
                    Node1="Coords=33,120" (comma-delimited)      OR
                    Node1="Coords=33;120" (semi-colon delimited) OR
                    Node1="Coords=33 120" (space-delimited)
                    

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    This field can instead contain the literal text of any absolute or relative coordinates in the same formats as shown above.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::DoubleClickScreenPoint (deprecated for: GenericObject DoubleClickScreenLocation)
TID

(Deprecated) DoubleClick a specified screen location.

(Deprecated) DoubleClick a specified screen location. See DoubleClickScreenLocation for the preferred method to click on screen coordinates.

We can click on any screen location based on literal text x,y coordinates retrieved from Field #5. Window and Component names and App Map entries are completely ignored. So the user can put anything in those fields that might help test readability.

It is not recommended to hardcode screen coordinates in the test table in this way.



Fields: [ ]=Optional with Default Value
  1. Coords
    The hardcoded X,Y screen coordinates--or the result of an expression--that provides the absolute screen coordinates to click.

    The coordinates must be in the following supported formats:

                    "33,120"        (comma-delimited)      OR
                    "33;120"        (semi-colon delimited) OR
                    "33 120"        (space-delimited)
                    

    Note the "Coords=" prefix is NOT supported for this deprecated command.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::DragTo
SE2

A left mouse drag is performed from one object to another object based on the offsets values.

Drag will be performed from component (from-component) to another to-component. Offsets value are the drag object select location. The location (drag and release) calucate by X and Y percentage cordination. DragTo also supports sub item of component and sub item of to-component.

The coordination specify by offsets value. First two values are for from-component and another are for to-component.


NOTE:
Offsets can be 50%,50%,50%,50% or 50%;50%;50%;50%
T, WINDOW,COMPONENT, DRAGTO, ToWINDOW,ToCOMPONENT,"50%,50%,50%,50%" Where first 50%,50% are COMPONENT or their subitem's X and Y location and second 50%,50% are ToCOMPONENT or their subitem's X and Y location.


Fields: [ ]=Optional with Default Value
  1. ToWindow
    ToWindow object.

    ToWindow recognition string define into AppMap.

  2. ToComponent
    ToComponent object.

    ToComponent recognition string define into AppMap.

  3. [ Offsets = ]
    Drag and release location of from-component and to-component. Offsets syntax will be "50%,50%,70%,70%"", where first two percentages are for from-component and second two are for to-component. If offsets are not specified then center will be used.
    Default value, both components center.

    NOTE:
    SE2 : The parameter 'Offsets' can be also given in pixel, like '20, 20, 70, 90'; or even in mix format, like "50%, 50%, 70, 90".

  4. [ FromSubItem = ]
    Text of from-component's sub item.

    FromSubItem as text. e.g tree node or list item or any sub main component's item.
    NOTE:
    SE2 : NOT supported yet.

  5. [ ToSubItem = ]
    Text of to-component's sub item.

    ToSubItem as text. e.g tree node or list item or any sub main component item.
    NOTE:
    SE2 : NOT supported yet.

  6. [ Pause = ]
    Pause time in millisecond to hold the button before releasing.

    The default pause time is 800 milliseconds, which may not enough for the AUT to react. User could provide a larger value according to his needs.
    NOTE:
    SE2 : Initially implemented, may not be supported for other engines.

Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::LeftDrag
TID SE2

A left mouse drag is performed on the object based on the stored coordinates.

For components that are unrecognized, we can make a mouse drag in these to draw fields(rectangles) or do drag and drop, based on stored x,y start and end coordinates. The object containing the starting coordinates is first given context and then a left mouse drag is performed with the stored coordinates.

The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow GenericItem LeftDrag DragName

#1 above will contain a GenericItem entry in the MainWindow section with normal recognition information for it . GenericItem will also have it's own section in the Application Map in which there will be an entry like:

                DragName="15,30,60,90"    OR
                DragName="Coords=15,30,60,90"
                

This will tell Robot to locate the GenericItem Window object and left drag from coordinates 15,30 to 60,90.

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. AppMapSubkey
    Name of the AppMap subkey to lookup or literal text to use for the left mouse drag.

    Name of the AppMap subkey to lookup and use for the left drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

                    [GenericItem]
                    DragName="3,10,12,20"     OR
                    DragName="Coords=3,10,12,20"
                    

    The results from the lookup are appended to the "Coords=" string used by the GenericObject Left_Drag command in Robot (if necessary). So any valid content used with the Left_Drag command can be part of this AppMap entry.

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.

    Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::MultiClick
TID

Multiple clicks on an object.

By default, clicks on the center of the component 3 times.
Use the optional ClickCount parameter to specify the desired number of clicks.
We can also click on any part of an object, or any point relative to an object based on a provided x,y coordinate or other component-specific parameters.

The object to be clicked is first given context and then the clicks are generated at the coordinates. Thus, a subitem or object can be referenced by name even though it is only recognized via coordinates.

The optional coordinate lookup is done with the component name of the record AND Field #5 or by providing the literal text of the coordinates, where supported.

Typical Data Table records with relative references:

(1) t MainWindow MainWindow MultiClick
(2) t MainWindow MainWindow MultiClick AnObject
(3) t MainWindow FolderTree MultiClick Node1 "4"
(4) t MainWindow MainWindow MultiClick "50,200" "3"
(5) t MainWindow MainWindow MultiClick "Coords=50,200" "2"

#1 above should click 3 times (default) at the center (default) of the MainWindow.

#2 above will contain an AnObject="3,10" entry in the MainWindow section of the Application Map to click 3 times (default) at x=3, y=10 in the MainWindow.

#3 above will contain a FolderTree entry in the MainWindow section with normal recognition information for it. FolderTree will also have it's own section in the Application Map in which there will be an entry like Node1="15,30". This will tell the runtime to locate the FolderTree Generic object and click 3 times (default) at the coordinates specified by the reference.

#4 and #5 above show using literal text instead of an App Map entry to specify where to click relative to the item. The item will be clicked 3 times and 2 times, respectively

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Optional)Name of the AppMap subkey to lookup or the literal text to use for the clicks.

    Without this we should click on the center of the object.

    Name of the AppMap subkey to lookup and use for the click. We expect the AppMap or literal text to contain the item in the format "x,y":

                    [FolderTree]
                    Node1="33,120"      OR
                    Node1="Coords=33,120"
                    ...
                    [AnHTMLImage]
                    AMappdedRegion=Coords=10,10
                    ANamedRegion=AreaName=TechSupport
                    AnIndexedRegion=AreaIndex=2
                    AnotherRegion=AreaID=Contact
                    

    The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (only if necessary). So any valid content used with the Click command can be part of this AppMap entry.

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.

    Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.



  2. [ ClickCount = 3 ]
    Optional number of times (1 to N) to click the item.

    Optional number of times (1 to N) to click the item. The default if no value is provided is 3.

Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::MultiClickScreenImage
TID

Same as MULTICLICK.

The keyword is simply provided as a means to differentiate Object-Based Testing from Image-Based Testing in your tests. However, this differentiation is not required.

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Optional)Name of the AppMap subkey to lookup or the literal text to use for the clicks.

    Same as MULTICLICK.
    The keyword is simply provided as a means to differentiate Object-Based Testing from Image-Based Testing in your tests. However, this differentiation is not required.

    Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



  2. [ ClickCount = 3 ]
    Optional number of times (1 to N) to click the item.

    Optional number of times (1 to N) to click the item. The default if no value is provided is 3.

Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::RightClick
TID SE SE2

A right click on an object.

By default we should click on the center of the object.

We can also right click on any part of an object based on a stored x,y coordinate. The object containing the coordinate is first given context and then a right click is generated at the coordinate. Thus, an item or object can be referenced by name even though it is only recognized via coordinates.

The coordinate lookup is done with the component name of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow MainWindow RightClick
(2) t MainWindow MainWindow RightClick AnObject
(3) t MainWindow ToolItem RightClick PrintTool

#2 above will contain an AnObject="3,10" entry in the MainWindow section of the Application Map to right click at x=3, y=10 in the MainWindow. For SE+, the coordinate can be percentage format, like "20%,30%". This percentage format indicates the point (20% width of component, 30% height of component) relative to the object.

#3 above will contain a ToolItem entry in the MainWindow section with normal recognition information for it . ToolItem will also have it's own section in the Application Map in which there will be an entry like PrintTool="15,30". This will tell Robot to locate the PrintTool Window object and right click at the coordinates specified by the reference.

Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

  • "," (comma) Example: "50,200"
  • ";" (semi-colon) Example: "50;200"
  • " " (space) Example: "50 200"

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Optional) Name of the AppMap subkey to lookup or the literal text to use for the right click.

    Without this we should click on the center of the object.

    Name of the AppMap subkey to lookup and use for the right click. We expect the AppMap or literal text to contain the item in the format "x,y":

                    [ToolItem]
                    PrintTool="33,120"      OR
                    PrintTool="Coords=33,120"
                    

    The results from the lookup are appended to the "Coords=" string used by the GenericObject Right_Click command in Robot (if necessary). So any valid content used with the Right_Click command can be part of this AppMap entry.

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

    • "," (comma) Example: "50,200"
    • ";" (semi-colon) Example: "50;200"
    • " " (space) Example: "50 200"

    Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.

    Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.

    Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).



  2. [ AutoScroll = ]
    (Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.

    If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
    If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

    NOTE:
    SE2 : For now, this optional parameter is only supported in Selenium2.0 Engine.

Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::RightClickScreenImage
TID

Same as RightClick.

The keyword is simply provided as a means to differentiate Object-Based Testing from Image-Based Testing in your tests. However, this differentiation is not required.

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubKey = ]
    (Optional) AppMapSubKey or literal text as documented in the CLICK command.


Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::RightClickScreenLocation
TID

RightClick a specified screen location.

RightClick a specified screen location.

We can click on any screen location based on stored x,y coordinates or hardcoded literal values. The Window:Component fields can be anything at all and will be ignored if they do not exist in the app map, or if the retrieved app map data does not contain coordinate data. Thus, an item or object can be referenced by name even though it is only known via coordinates.

If the Window:Component AppMap lookup does NOT contain coordinate data and is ignored, then the AppMapSubKey field is REQUIRED and is expected to contain a reference or literal text containing absolute screen coordinates.

If the Window:Component AppMap lookup DOES contain coordinate data, this data is treated as the absolute screen coordinates to be used. The AppMapSubKey field becomes OPTIONAL and coordinate data in the field is treated as a relative offset added to the absolute values found for the Window:Component.

Any AppMapSubKey lookup is done with the Component name in the record AND Field #5.

Typical Data Table records:

(1) t MainWindow Component RightClickScreenLocation
(2) t MainWindow MainWindow RightClickScreenLocation AnObject
(3) t MainWindow MainWindow RightClickScreenLocation 50,80
(4) t AnyWin AnyComp RightClickScreenLocation Node1

#1 above will contain a blank as it's 5th field. Because the AppMapSubKey field is blank, the [MainWindow] section of the AppMap MUST have a Component item with valid absolute screen coordinates for the click.

#2 above will contain an AnObject="Coords=50,80" entry in the [MainWindow] section of the AppMap. If there is a MainWindow component in the AppMap with valid screen coordinates then the click will occur with a relative offset of 50,80 from those absolute screen coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.

#3 If there is a MainWindow component in the [MainWindow] section of the AppMap with valid screen coordinates then the click will occur with a relative offset of 50,80 from those absolute screen coordinates. Otherwise, the click will occur at absolute screen coordinates 50,80.

#4 above will contain no valid AnyWin:AnyComp coordinate data and those fields will be ignored. However, Node1 MUST exist in the Application Map [AnyComp] section to provide absolute screen coordinates for the click.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Sometimes Optional)Name of the AppMap subkey to locate in the AppMap.

    Without this there MUST be absolute screen coordinates stored in the AppMap for the Window:Component specified.

    Name of the AppMap subkey to locate in the App Map. We expect the AppMap to contain the coordinates in the following supported formats:

                    [Component]
                    Node1="33,120"        (comma-delimited)      OR
                    Node1="33;120"        (semi-colon delimited) OR
                    Node1="33 120"        (space-delimited)      OR
                    Node1="Coords=33,120" (comma-delimited)      OR
                    Node1="Coords=33;120" (semi-colon delimited) OR
                    Node1="Coords=33 120" (space-delimited)
                    

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    This field can instead contain the literal text of any absolute or relative coordinates in the same formats as shown above.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::RightClickScreenPoint (deprecated for: GenericObject RightClickScreenLocation)
TID

(Deprecated) RightClick a specified screen location.

(Deprecated) RightClick a specified screen location. See RightClickScreenLocation for the preferred method to click on screen coordinates.

We can click on any screen location based on literal text x,y coordinates retrieved from Field #5. Window and Component names and App Map entries are completely ignored. So the user can put anything in those fields that might help test readability.

It is not recommended to hardcode screen coordinates in the test table in this way.



Fields: [ ]=Optional with Default Value
  1. Coords
    The hardcoded X,Y screen coordinates--or the result of an expression--that provides the absolute screen coordinates to click.

    The coordinates must be in the following supported formats:

                    "33,120"        (comma-delimited)      OR
                    "33;120"        (semi-colon delimited) OR
                    "33 120"        (space-delimited)
                    

    Note the "Coords=" prefix is NOT supported for this deprecated command.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::RightDrag
TID SE2

A right mouse drag is performed on the object based on the stored coordinates.

For components that are unrecognized, we can make a mouse drag in these to draw fields(rectangles) or do drag and drop, based on stored x,y start and end coordinates. The object containing the starting coordinates is first given context and then a right mouse drag is performed with the stored coordinates.

The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow GenericItem RightDrag DragName

#1 above will contain a GenericItem entry in the MainWindow section with normal recognition information for it . GenericItem will also have it's own section in the Application Map in which there will be an entry like:

DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"

This will tell Robot to locate the GenericItem Window object and right drag from coordinates 15,30 to 60,90.

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. AppMapSubkey
    Name of the AppMap subkey to lookup or literal text to use for the right mouse drag.

    Name of the AppMap subkey to lookup and use for the right drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

                    [GenericItem]
                    DragName="3,10,12,20"     OR
                    DragName="Coords=3,10,12,20"
                    

    The results from the lookup are appended to the "Coords=" string used by the GenericObject Left_Drag command in Robot (if necessary). So any valid content used with the Right_Drag command can be part of this AppMap entry.

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.

    Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.



Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::ShiftClick
TID SE SE2

A SHIFT click on an object.

By default we should click on the center of the object.

We can SHIFT click on any part of an object based on a stored x,y coordinate. The object containing the coordinate is first given context and then a SHIFT click is generated at the coordinate. Thus, an item or object can be referenced by name even though it is only recognized via coordinates.

The coordinate lookup is done with the component name of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow MainWindow ShiftClick
(2) t MainWindow MainWindow ShiftClick AnObject
(3) t MainWindow ToolItem ShiftClick PrintTool

#2 above will contain an AnObject="3,10" entry in the MainWindow section of the Application Map to SHIFT click at x=3, y=10 in the MainWindow. For SE+, the coordinate can be percentage format, like "20%,30%". This percentage format indicates the point (20% width of component, 30% height of component) relative to the object.

#3 above will contain a ToolItem entry in the MainWindow section with normal recognition information for it . ToolItem will also have it's own section in the Application Map in which there will be an entry like PrintTool="15,30". This will tell Robot to locate the PrintTool Window object and SHIFT click at the coordinates specified by the reference.

Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

  • "," (comma) Example: "50,200"
  • ";" (semi-colon) Example: "50;200"
  • " " (space) Example: "50 200"



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (Optional) Name of the AppMap subkey to lookup and use for the SHIFT click.

    Without this we should click on the center of the object.

    Name of the AppMap subkey to lookup and use for the SHIFT click. We expect the AppMap to contain the item in the format "x,y":

                    [ToolItem]
    PrintTool="33,120" OR PrintTool="Coords=33,120"

    The results from the lookup are appended to the "Coords=" string used by the GenericObject Shift_Click command in Robot (if necessary). So any valid content used with the Shift_Click command can be part of this AppMap entry.

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

    • "," (comma) Example: "50,200"
    • ";" (semi-colon) Example: "50;200"
    • " " (space) Example: "50 200"

    Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).



  2. [ AutoScroll = ]
    (Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.

    If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
    If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

    NOTE:
    SE2 : For now, this optional parameter is only supported in Selenium2.0 Engine.

Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::ShiftClickScreenImage
TID

Same as ShiftClick.

The keyword is simply provided as a means to differentiate Object-Based Testing from Image-Based Testing in your tests. However, this differentiation is not required.

Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.



Fields: [ ]=Optional with Default Value
  1. [ AppMapSubKey = ]
    (Optional) AppMapSubKey type of use as documented in the CLICK command.


Examples:
[How To Read This Reference]

Selenium GenericObjectFunctions::ShiftLeftDrag
SE2

A SHIFT left mouse drag is performed on the object based on the stored coordinates.

The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.

Typical Data Table records:

(1) t MainWindow GenericItem ShiftLeftDrag DragName

#1 above will contain a GenericItem entry in the MainWindow section with normal recognition information for it . GenericItem will also have it's own section in the Application Map in which there will be an entry like:

DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"

This will tell RFT to locate the GenericItem Window object and SHIFT left drag from coordinates 15,30 to 60,90.



Fields: [ ]=Optional with Default Value
  1. AppMapSubkey
    Name of the AppMap subkey to lookup or literal text to use for the SHIFT left mouse drag.

    Name of the AppMap subkey to lookup and use for the operation. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

                      [GenericItem]
                      DragName="3,10,12,20"     OR
                      DragName="Coords=3,10,12,20"
                      

    Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



Examples:
[How To Read This Reference]