ÿþ<HTML xmlns="http://www.w3.org/TR/REC-html40"> <HEAD> <TITLE>GenericObjectFunctions</TITLE> <LINK rel="stylesheet" href="rrafs.css" type="text/css"/> </HEAD> <BODY> <DIV NAME="top" ID="top"> <H3>GenericObjectFunctions</H3> <SMALL>Last Updated:<script language="JavaScript">document.write(document.lastModified)</script></SMALL> <BR/> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Actions for working with GENERIC objects </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""></detailed_desc><BR/> </DIV> </DIV> <BR/> <DIV NAME="list" ID="list"> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <TABLE cellspacing="3" border="1" cellpadding="2"> <TR> <TD nowrap="true" width="27%"><A NAME='list_AltLeftDrag' HREF='#detail_AltLeftDrag' >AltLeftDrag</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </TD> <TD> An ALT left mouse drag is performed on the object based on the stored coordinates. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_Click' HREF='#detail_Click' >Click</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='DRD.GIF' ALT='Android'/></TD> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='ABT.GIF' ALT='Abbot Commands'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> A single click on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ClickScreenImage' HREF='#detail_ClickScreenImage' >ClickScreenImage</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> Same as Click. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ClickScreenLocation' HREF='#detail_ClickScreenLocation' >ClickScreenLocation</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> Click a specified screen location. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A ID="linkdeprecated" NAME='list_ClickScreenPoint' HREF='#detail_ClickScreenPoint' >ClickScreenPoint</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD>Deprecated For:GenericObject ClickScreenLocation</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CompareStoredData' HREF='#detail_CompareStoredData' >CompareStoredData</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> </TR></TABLE> </TD> <TD> Performs a GenericObjectVP CompareData on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CompareStoredProperties' HREF='#detail_CompareStoredProperties' >CompareStoredProperties</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Performs a GenericObjectVP CompareProperties on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CtrlAltLeftDrag' HREF='#detail_CtrlAltLeftDrag' >CtrlAltLeftDrag</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </TD> <TD> CTRL ALT left mouse drag is performed on the object based on the stored coordinates. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CtrlClick' HREF='#detail_CtrlClick' >CtrlClick</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='ABT.GIF' ALT='Abbot Commands'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> A CTRL-click on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CtrlClickScreenImage' HREF='#detail_CtrlClickScreenImage' >CtrlClickScreenImage</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> Same as CtrlClick. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CtrlLeftDrag' HREF='#detail_CtrlLeftDrag' >CtrlLeftDrag</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </TD> <TD> A CTRL left mouse drag is performed on the object based on the stored coordinates. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CtrlRightClick' HREF='#detail_CtrlRightClick' >CtrlRightClick</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> A CTRL-Right click on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CtrlRightClickScreenImage' HREF='#detail_CtrlRightClickScreenImage' >CtrlRightClickScreenImage</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> Same as CtrlRightClick. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CtrlShiftLeftDrag' HREF='#detail_CtrlShiftLeftDrag' >CtrlShiftLeftDrag</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </TD> <TD> A CTRL SHIFT left mouse drag is performed on the object based on the stored coordinates. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_DoubleClick' HREF='#detail_DoubleClick' >DoubleClick</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> <TD class="borderStyle"><IMG SRC='ABT.GIF' ALT='Abbot Commands'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> A double click on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_DoubleClickScreenImage' HREF='#detail_DoubleClickScreenImage' >DoubleClickScreenImage</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> Same as DoubleClick. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_DoubleClickScreenLocation' HREF='#detail_DoubleClickScreenLocation' >DoubleClickScreenLocation</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> DoubleClick a specified screen location. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A ID="linkdeprecated" NAME='list_DoubleClickScreenPoint' HREF='#detail_DoubleClickScreenPoint' >DoubleClickScreenPoint</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD>Deprecated For:GenericObject DoubleClickScreenLocation</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_DoubleTap' HREF='#detail_DoubleTap' >DoubleTap</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </TD> <TD> A double-tap on a touchscreen object. Use keyword "DoubleClick" syntax and parameters. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_DragTo' HREF='#detail_DragTo' >DragTo</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> </TR></TABLE> </TD> <TD> A left mouse drag is performed from one object to another object based on the offsets values. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_Flick' HREF='#detail_Flick' >Flick</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </TD> <TD> A user-defined flick or swipe on a touchscreen object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_FlickDown' HREF='#detail_FlickDown' >FlickDown</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </TD> <TD> A flick or swipe on a touchscreen object from top-to-bottom. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_FlickLeft' HREF='#detail_FlickLeft' >FlickLeft</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </TD> <TD> A flick or swipe on a touchscreen object from right-to-left. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_FlickRight' HREF='#detail_FlickRight' >FlickRight</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </TD> <TD> A flick or swipe on a touchscreen object from left-to-right. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_FlickUp' HREF='#detail_FlickUp' >FlickUp</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </TD> <TD> A flick or swipe on a touchscreen object from bottom-to-top. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_HScrollTo' HREF='#detail_HScrollTo' >HScrollTo</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </TD> <TD> Attempts to perform an HScrollTo on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_JavaMenuSelect' HREF='#detail_JavaMenuSelect' >JavaMenuSelect</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> Select a JAVA Menu Item according to a stored text value. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_LeftDrag' HREF='#detail_LeftDrag' >LeftDrag</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> A left mouse drag is performed on the object based on the stored coordinates. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_MouseClick' HREF='#detail_MouseClick' >MouseClick</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </TD> <TD> A single click on an object by mouse event. It uses low level mouse event to click on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_MultiClick' HREF='#detail_MultiClick' >MultiClick</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> Multiple clicks on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_MultiClickScreenImage' HREF='#detail_MultiClickScreenImage' >MultiClickScreenImage</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> Same as MULTICLICK. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_Press' HREF='#detail_Press' >Press</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='DRD.GIF' ALT='Android'/></TD> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </TD> <TD> Press a touchscreen object for a number of seconds--0 seconds by default. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_RightClick' HREF='#detail_RightClick' >RightClick</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> <TD class="borderStyle"><IMG SRC='ABT.GIF' ALT='Abbot Commands'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> A right click on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_RightClickScreenImage' HREF='#detail_RightClickScreenImage' >RightClickScreenImage</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> Same as RightClick. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_RightClickScreenLocation' HREF='#detail_RightClickScreenLocation' >RightClickScreenLocation</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> RightClick a specified screen location. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A ID="linkdeprecated" NAME='list_RightClickScreenPoint' HREF='#detail_RightClickScreenPoint' >RightClickScreenPoint</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD>Deprecated For:GenericObject RightClickScreenLocation</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_RightDrag' HREF='#detail_RightDrag' >RightDrag</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </TD> <TD> A right mouse drag is performed on the object based on the stored coordinates. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ShiftClick' HREF='#detail_ShiftClick' >ShiftClick</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> <TD class="borderStyle"><IMG SRC='ABT.GIF' ALT='Abbot Commands'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> A SHIFT click on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ShiftClickScreenImage' HREF='#detail_ShiftClickScreenImage' >ShiftClickScreenImage</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </TD> <TD> Same as ShiftClick. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ShiftLeftDrag' HREF='#detail_ShiftLeftDrag' >ShiftLeftDrag</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </TD> <TD> A SHIFT left mouse drag is performed on the object based on the stored coordinates. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_Tap' HREF='#detail_Tap' >Tap</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='DRD.GIF' ALT='Android'/></TD> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </TD> <TD> A single Tap on a touchscreen object. Use keyword "Click" syntax and parameters. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_TwoFingerTap' HREF='#detail_TwoFingerTap' >TwoFingerTap</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </TD> <TD> A two-finger tap on a touchscreen object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_VerifyImage' HREF='#detail_VerifyImage' >VerifyImage</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> </TR></TABLE> </TD> <TD> Performs a GenericObjectVP CompareImage OR a RegionImageVP on an object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_VScrollTo' HREF='#detail_VScrollTo' >VScrollTo</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </TD> <TD> Attempts to perform a VScrollTo on an object. </TD> </TR> </TABLE> <HR/> </DIV> <DIV NAME="detail" ID="detail"> <H3><A NAME='detail_AltLeftDrag' />GenericObjectFunctions::<BIG>AltLeftDrag</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> An ALT left mouse drag is performed on the object based on the stored coordinates. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow GenericItem CtrlAltLeftDrag DragName</p><p> #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:</p><p> DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"</p><p> This will tell RFT to locate the GenericItem Window object and an ALT left mouse drag from coordinates 15,30 to 60,90.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>AppMapSubkey</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the AppMap subkey to lookup or literal text to use for an ALT left mouse drag. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>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":</p><p><pre> [GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20" </pre></p><p> 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. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, ALTLEFTDRAG, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> An ALT left mouse drag will be performed based on coordinates indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, ALTLEFTDRAG, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> An ALT left mouse drag will be performed based on coordinates indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, ALTLEFTDRAG, "Coords=10;20;200;300"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> An ALT left mouse drag will be performed from point 10,20 to 200,300 relative to AnObject. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_Click' />GenericObjectFunctions::<BIG>Click</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='DRD.GIF' ALT='Android'/></TD> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='ABT.GIF' ALT='Abbot Commands'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> 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. </p><p> 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. </p><p> 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.</p><p> Typical Data Table records:</p><p> (1) t MainWindow MainWindow Click<br> (2) t MainWindow MainWindow Click AnObject<br> (3) t MainWindow FolderTree Click Node1<br> (4) t MainWindow MainWindow Click "50,200"<br> (5) t MainWindow MainWindow Click "Coords=50,200"</p><p> #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. </p><p> #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. </p><p> #4 and #5 above show using literal text instead of an App Map entry to specify where to click relative to the item. </p><p> 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. </p><p> 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. </p><p> This is the direction we expect all tools to follow going forward. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p><p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p><p>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. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional)Name of the AppMap subkey to lookup or the literal text to use for the click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this we should click on the center of the object. <p>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":</p><pre> [FolderTree] Node1="33,120" OR Node1="Coords=33,120" ... [AnHTMLImage] AMappdedRegion=Coords=10,10 ANamedRegion=AreaName=TechSupport AnIndexedRegion=AreaIndex=2 AnotherRegion=AreaID=Contact </pre><p> 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.</p><p> 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. </p><p> 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. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p><p><b>Important TID note.</b> The <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">TID IBT implementation</a> 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. </p><p> 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. </p><p><b>Important Abbot note.</b> Presently, there is no support for AppMapSubkey specification (5th field). </p><p>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. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, CLICK</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on the center of the object. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, CLICK, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click will be performed at a x,y coordinate indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to click This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CLICK, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click will be performed at a x,y coordinate indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to click This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CLICK, 10;20</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click will be performed at coordinate 10,20 in the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CLICK, "Coords=10;20"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click will be performed at coordinate 10,20 in the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_ClickScreenImage' />GenericObjectFunctions::<BIG>ClickScreenImage</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Same as Click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 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. <p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubKey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) AppMapSubKey type of use as documented in the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, ClickScreenImage</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on the center of the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on the center of the item. Refer to the CLICK command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, ClickScreenImage, AppMapLookup</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on a point relative to the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on a point relative to the item. Refer to the CLICK command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, ClickScreenImage, "Coords=50;200"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on a point relative to the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on a point relative to the item. Refer to the CLICK command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_ClickScreenLocation' />GenericObjectFunctions::<BIG>ClickScreenLocation</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click a specified screen location. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Click a specified screen location. <p>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. </p><p> 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. </p><p> 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. </p><p> Any AppMapSubKey lookup is done with the Component name in the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow Component ClickScreenLocation<br> (2) t MainWindow MainWindow ClickScreenLocation AnObject<br> (3) t MainWindow MainWindow ClickScreenLocation 50,80<br> (4) t AnyWin AnyComp ClickScreenLocation Node1</p><p> #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.</p><p> #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.</p><p> #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.</p><p> #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.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Sometimes Optional)Name of the AppMap subkey to locate in the AppMap. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this there MUST be absolute screen coordinates stored in the AppMap for the Window:Component specified. <p> Name of the AppMap subkey to locate in the App Map. We expect the AppMap to contain the coordinates in the following supported formats: </p><p><pre> [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) </pre></p><p> 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.</p><p> This field can instead contain the literal text of any absolute or relative coordinates in the same formats as shown above. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, ClickScreenLocation</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click at specified screen coordinates for WINDOW. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Click at screen coordinates specified for the Window item stored in the [Window] section of the current AppMap. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, ClickScreenLocation, "Coords=200,400"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click at screen coordinates 200,400. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Click at screen coordinates 200,400. This assumes AnObject is NOT an item in the [Window] section of the current AppMap with valid coordinate data. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, ClickScreenLocation, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click at screen coordinates stored in the ASubObject reference in the [AnObject] section of the current AppMap. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> ASubObject reference found in the AppMap [AnObject] section must contain the screen coordinates on which to click. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, ClickScreenLocation</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click on the Window:AnObject screen coordinates. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Because no AppMapSubKey is provided the AnObject item MUST exist in the [WINDOW] section of the current AppMap and it MUST contain valid screen coordinate data. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_ClickScreenPoint' />GenericObjectFunctions::<SPAN ID="deprecated">ClickScreenPoint</SPAN> (deprecated for: <B>GenericObject ClickScreenLocation</B>) <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Deprecated) Click a specified screen location. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> (Deprecated) Click a specified screen location. See <a href="#detail_ClickScreenLocation">ClickScreenLocation</a> for the preferred method to click on screen coordinates. <p> 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. </p><p> It is not recommended to hardcode screen coordinates in the test table in this way. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>Coords</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The hardcoded X,Y screen coordinates--or the result of an expression--that provides the absolute screen coordinates to click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The coordinates must be in the following supported formats: <p><pre> "33,120" (comma-delimited) OR "33;120" (semi-colon delimited) OR "33 120" (space-delimited) </pre></p><p> Note the "Coords=" prefix is NOT supported for this deprecated command. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, BogusWin, BogusComp, ClickScreenPoint, 33;120</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click at screen coordinates 33,120. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Click at screen coordinates 33,120 </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_CompareStoredData' />GenericObjectFunctions::<BIG>CompareStoredData</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a GenericObjectVP CompareData on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY RUNNING SCRIPT.</p><p> Modified VP parameter information can be added to the standard VP=VPName by including the VPName reference in the application map in a section defined for the object. If this is done, the value retrieved from the application map will be appended to VP=VPName. The required semicolon for this append will be provided by this routine.</p><p> Example 1: Perform a standard HTMLImage CompareData. To perform a basic CompareData the name "StoredVP" will not exist in the app map:</p><p> The Step File call:</p><p> BrowserWindow AnHTMLImage CompareStoredData StoredVP</p><p> This will produce a CompareData VP with "VP=StoredVP;Wait=2,10".</p><p> The StoredVP baseline MUST already exist as an asset of the currently running script.</p><p> Example 2: Perform a HTMLImage CompareData providing addition parameter information (such as ExpectedResult=FAIL). To do this the HTMLImage object must have its own section in the app map and an item with the same name as the StoredVP. The value of that item will be appended to the standard VP argument with a semicolon.</p><p> Part of App Map:</p><pre> [BrowserWindow] BrowserWindow=WindowTag=WEBBrowser AnHTMLImage=&lt;snipped for brevity&gt;;\;Type=HTMLImage;Index=1 ... [AnHTMLImage] StoredVP=ExpectedResult=FAIL;Wait=3,30 </pre><p> The Step File call:</p><p> BrowserWindow AnHTMLImage CompareStoredData StoredVP</p><p> This will produce a CompareData VP with all the parameters appended like this: "VP=StoredVP;ExpectedResult=FAIL;Wait=3,30". NOTE:When stored parameters are found in the app map then the default Wait= parameter used in the standard compare is no longer provided. If you still need a Wait= parameter, then it must be included in the stored parameters.</p><p> The StoredVP baseline MUST already exist as an asset of the currently running script.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>VPAsset</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the pre-existing VP asset stored in the currently running script. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then the additional stored parameters are appended to the VP call. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>AddParams</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Additional parameter name used for lookup, or as literal text. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Another parameter that can be stored as a lookup reference in the app map that will be added to any also stored in the app map under the VP name. This parameter will also be treated as literal text if lookup in the app map fails. In this way, we can add parameters to the VP thru literal text instead of requiring any App Map entry. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WebBrowser, SiteMapImage, COMPARESTOREDDATA, "AStoredVP"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> This action compares stored data on the SiteMapImage object against "AStoredVP". </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>Field 5 : TQ String. The name of a stored CompareData VP which must exist as an asset of the currently running script. You can also specify additional VP parameters by including a reference in the application map.</p><p>[URLLink]</p><p>AStoredVP=ExpectedResult=FAIL;Wait=3,30</p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, COMPARESTOREDDATA, "AStoredVP", "ExpectedResult=FAIL"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> This action performs a CompareData VP on AnObject against the "AStoredVP" benchmark. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The name of a stored CompareData VP which must exist as an asset of the currently running script. <p> Field 6 : TQ String. Literal text to be added to the VP info for execution. </p></detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_CompareStoredProperties' />GenericObjectFunctions::<BIG>CompareStoredProperties</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a GenericObjectVP CompareProperties on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>Performs a GenericObjectVP CompareProperties on an object.</p><p> THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY RUNNING SCRIPT.</p><p> Modified VP parameter information can be added to the standard VP=VPName by including the VPName reference in the application map in a section defined for the object. If this is done, the value retrieved from the application map will be appended to VP=VPName. The required semicolon for this append will be provided by this routine.</p><p> Example 1: Perform a standard HTMLImage CompareProperties. To perform a basic CompareProperties the name "StoredVP" will not exist in the app map:</p><p> The Step File call:</p><p> BrowserWindow AnHTMLImage CompareStoredProperties StoredVP</p><p> This will produce a VP with "VP=StoredVP;Wait=2,10".</p><p> The StoredVP baseline MUST already exist as an asset of the currently running script.</p><p> Example 2: Perform a HTMLImage CompareProperties providing addition parameter information (such as ExpectedResult=FAIL). To do this the HTMLImage object must have its own section in the app map and an item with the same name as the StoredVP. The value of that item will be appended to the standard VP argument with a semicolon.</p><p> Part of App Map:</p><pre> [BrowserWindow] BrowserWindow=WindowTag=WEBBrowser AnHTMLImage=&lt;snipped for brevity&gt;;\;Type=HTMLImage;Index=1 ... [AnHTMLImage] StoredVP=ExpectedResult=FAIL;Wait=3,30 </pre><p> The Step File call:</p><p> BrowserWindow AnHTMLImage CompareStoredProperties StoredVP</p><p> This will produce a VP with all the parameters appended like this: "VP=StoredVP;ExpectedResult=FAIL;Wait=3,30". NOTE:When stored parameters are found in the app map then the default Wait= parameter used in the standard compare is no longer provided. If you still need a Wait= parameter, then it must be included in the stored parameters.</p><p> The StoredVP baseline MUST already exist as an asset of the currently running script.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>VPAsset</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the pre-existing VP asset stored in the currently running script. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Name of the pre-existing VP asset stored in the currently running script. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>AddParams</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Additional parameter name used for lookup, or as literal text. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Another parameter that can be stored as a lookup reference in the app map that will be added to any also stored in the app map under the VP name. This parameter will also be treated as literal text if lookup in the app map fails. In this way, we can add parameters to the VP thru literal text instead of requiring any App Map entry. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, AnObject, COMPARESTOREDPROPERTIES, "AStoredVP"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> This action performs a CompareProperties on AnObject against the "AStoredVP" benchmark. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The name of a stored ComparePropertiesVP which must exist as an asset of the currently running script. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, COMPARESTOREDPROPERTIES, "AStoredVP", "ExpectedResult=FAIL"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> This action performs a CompareProperties on AnObject against the "AStoredVP" benchmark. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The name of a stored ComparePropertiesVP which must exist as an asset of the currently running script. <p> Field 6 : TQ String. Literal text to be added to the VP info for execution. </p></detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_CtrlAltLeftDrag' />GenericObjectFunctions::<BIG>CtrlAltLeftDrag</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> CTRL ALT left mouse drag is performed on the object based on the stored coordinates. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow GenericItem CtrlAltLeftDrag DragName</p><p> #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:</p><p> DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"</p><p> This will tell RFT to locate the GenericItem Window object and CTRL ALT left mouse drag from coordinates 15,30 to 60,90.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>AppMapSubkey</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the AppMap subkey to lookup or literal text to use for the CTRL ALT left mouse drag. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>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":</p><p><pre> [GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20" </pre></p><p> 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. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, CTRLALTLEFTDRAG, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL ALT left mouse drag will be performed based on coordinates indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CTRLALTLEFTDRAG, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL ALT left mouse drag will be performed based on coordinates indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CTRLALTLEFTDRAG, "Coords=10;20;200;300"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL ALT left mouse drag will be performed from point 10,20 to 200,300 relative to AnObject. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_CtrlClick' />GenericObjectFunctions::<BIG>CtrlClick</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='ABT.GIF' ALT='Abbot Commands'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL-click on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> By default we should click the center of the object. <p>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.</p><p> The coordinate lookup is done with the component name of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow MainWindow CtrlClick<br> (2) t MainWindow MainWindow CtrlClick AnObject<br> (3) t MainWindow ToolItem CtrlClick PrintTool</p><p> #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.</p><p> #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. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) Name of the AppMap subkey to lookup and use for the CTRL-click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this we should click the center of the object. <p>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":</p><p><pre> [ToolItem] PrintTool="33,120" OR PrintTool="Coords=33,120" </pre></p><p> 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.</p><p> 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. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p><p><b>Important Abbot note.</b> Presently, there is no support for AppMapSubkey specification (5th field). </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, CTRLCLICK</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL-click will be performed on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A CTRL-click will be performed on the center of the object. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, CTRLCLICK, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL-click will be performed at a x,y coordinate indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to CTRL-click This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CTRLCLICK, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL-click will be performed at a x,y coordinate indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to CTRL-click This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_CtrlClickScreenImage' />GenericObjectFunctions::<BIG>CtrlClickScreenImage</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Same as CtrlClick. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 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. <p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubKey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) AppMapSubKey type of use as documented in the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, CtrlClickScreenImage</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on the center of the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on the center of the item with CTRL key pressed. Refer to the CTRLCLICK command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, CtrlClickScreenImage, AppMapLookup</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on a point relative to the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on a point relative to the item with CTRL key pressed. Refer to the CTRLCLICK command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, CtrlClickScreenImage, "Coords=50;200"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on a point relative to the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on a point relative to the item with CTRL key pressed. Refer to the CTRLCLICK command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_CtrlLeftDrag' />GenericObjectFunctions::<BIG>CtrlLeftDrag</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL left mouse drag is performed on the object based on the stored coordinates. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow GenericItem CtrlLeftDrag DragName</p><p> #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:</p><p> DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"</p><p> This will tell RFT to locate the GenericItem Window object and CTRL left drag from coordinates 15,30 to 60,90.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>AppMapSubkey</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the AppMap subkey to lookup or literal text to use for the CTRL left mouse drag. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>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":</p><p><pre> [GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20" </pre></p><p> 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. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, CTRLLEFTDRAG, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL left mouse drag will be performed based on coordinates indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CTRLLEFTDRAG, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL left mouse drag will be performed based on coordinates indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CTRLLEFTDRAG, "Coords=10;20;200;300"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A SHIFT left drag will be performed from point 10,20 to 200,300 relative to AnObject. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_CtrlRightClick' />GenericObjectFunctions::<BIG>CtrlRightClick</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL-Right click on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> By default we should click the center of the object. <p>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.</p><p> The coordinate lookup is done with the component name of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow MainWindow CtrlRightClick<br> (2) t MainWindow MainWindow CtrlRightClick AnObject<br> (3) t MainWindow ToolItem CtrlRightClick PrintTool</p><p> #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.</p><p> #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.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) Name of the AppMap subkey to lookup and use for the CTRL-Right-Click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this we should click the center of the object. <p>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":</p><p><pre> [ToolItem] PrintTool="33,120" OR PrintTool="Coords=33,120" </pre></p><p> 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.</p><p> 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.</p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, CtrlRightClick</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL-Right-Click will be performed on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A CTRL-Right-Click will be performed on the center of the object. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, CtrlRightClick, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL-Right-Click will be performed at a x,y coordinate indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to CTRL-Right-Click. This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CtrlRightClick, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL-Right-Click will be performed at a x,y coordinate indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to CTRL-Right-Click This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_CtrlRightClickScreenImage' />GenericObjectFunctions::<BIG>CtrlRightClickScreenImage</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Same as CtrlRightClick. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 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. <p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubKey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) AppMapSubKey type of use as documented in the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, CtrlRightClickScreenImage</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single right-click on the center of the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single right-click on the center of the item with CTRL key pressed. Refer to the CtrlRightClick command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, CtrlRightClickScreenImage, AppMapLookup</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single right-click on a point relative to the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single right-click on a point relative to the item with CTRL key pressed. Refer to the CtrlRightClick command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, CtrlRightClickScreenImage, "Coords=50;200"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single right-click on a point relative to the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single right-click on a point relative to the item with CTRL key pressed. Refer to the CtrlRightClick command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_CtrlShiftLeftDrag' />GenericObjectFunctions::<BIG>CtrlShiftLeftDrag</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL SHIFT left mouse drag is performed on the object based on the stored coordinates. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow GenericItem CtrlShiftLeftDrag DragName</p><p> #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:</p><p> DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"</p><p> This will tell RFT to locate the GenericItem Window object and CTRL SHIFT left mouse drag from coordinates 15,30 to 60,90.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>AppMapSubkey</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the AppMap subkey to lookup or literal text to use for the CTRL SHIFT left mouse drag. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>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":</p><p><pre> [GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20" </pre></p><p> 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. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, CTRLSHIFTLEFTDRAG, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL SHIFT left mouse drag will be performed based on coordinates indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CTRLSHIFTLEFTDRAG, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A CTRL SHIFT left mouse drag will be performed based on coordinates indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, CTRLSHIFTLEFTDRAG, "Coords=10;20;200;300"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A SHIFT left drag will be performed from point 10,20 to 200,300 relative to AnObject. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_DoubleClick' />GenericObjectFunctions::<BIG>DoubleClick</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> <TD class="borderStyle"><IMG SRC='ABT.GIF' ALT='Abbot Commands'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A double click on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> By default we should click the center of the object. <p>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.</p><p> The coordinate lookup is done with the component name of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow MainWindow DoubleClick<br> (2) t MainWindow MainWindow DoubleClick AnObject<br> (3) t MainWindow FolderTree DoubleClick Node1</p><p> #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.</p><p> #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. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p><p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p><p>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. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) Name of the AppMap subkey to lookup or the literal text to use for the double click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this we should click the center of the object. <p>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":</p><p><pre> [FolderTree] Node1="33,120" OR Node1="Coords=33,120" </pre></p><p> 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.</p><p> 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.</p><p><b>Important Abbot note.</b> Presently, there is no support for AppMapSubkey specification (5th field). </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p><p><b>Important TID note.</b> The <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">TID IBT implementation</a> 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. </p><p> 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. </p><p>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. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, DOUBLECLICK</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A double click should be performed on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A double click should be performed on the center of the object. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, DOUBLECLICK, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A double click will be performed at a x,y coordinate indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to double-click This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, DOUBLECLICK, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A double click will be performed at a x,y coordinate indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to double-click This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, DOUBLECLICK, "Coords=10;20"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A double click will be performed at coordinate 10,20 in the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_DoubleClickScreenImage' />GenericObjectFunctions::<BIG>DoubleClickScreenImage</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Same as DoubleClick. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 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. <p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubKey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) AppMapSubKey as documented in the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, DoubleClickScreenImage</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A double-click on the point as documented in the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A double-click on the point as documented in the CLICK command. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, DoubleClickScreenImage, AppMapItem</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A double-click on the point as documented in the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A double-click on the point as documented in the CLICK command. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, DoubleClickScreenImage, "50;100"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A double-click on the point as documented in the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A double-click on the point as documented in the CLICK command. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, DoubleClickScreenImage, "Coords=50;100"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A double-click on the point as documented in the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A double-click on the point as documented in the CLICK command. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_DoubleClickScreenLocation' />GenericObjectFunctions::<BIG>DoubleClickScreenLocation</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> DoubleClick a specified screen location. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> DoubleClick a specified screen location. <p>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. </p><p> 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. </p><p> 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. </p><p> Any AppMapSubKey lookup is done with the Component name in the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow Component DoubleClickScreenLocation<br> (2) t MainWindow MainWindow DoubleClickScreenLocation AnObject<br> (3) t MainWindow MainWindow DoubleClickScreenLocation 50,80<br> (4) t AnyWin AnyComp DoubleClickScreenLocation Node1</p><p> #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.</p><p> #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.</p><p> #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.</p><p> #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.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Sometimes Optional)Name of the AppMap subkey to locate in the AppMap. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this there MUST be absolute screen coordinates stored in the AppMap for the Window:Component specified. <p> Name of the AppMap subkey to locate in the App Map. We expect the AppMap to contain the coordinates in the following supported formats: </p><p><pre> [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) </pre></p><p> 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.</p><p> This field can instead contain the literal text of any absolute or relative coordinates in the same formats as shown above. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, DoubleClickScreenLocation</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> DoubleClick at specified screen coordinates for WINDOW. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> DoubleClick at screen coordinates specified for the Window item stored in the [Window] section of the current AppMap. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, DoubleClickScreenLocation, "Coords=200,400"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> DoubleClick at screen coordinates 200,400. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> DoubleClick at screen coordinates 200,400. This assumes AnObject is NOT an item in the [Window] section of the current AppMap with valid coordinate data. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, DoubleClickScreenLocation, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> DoubleClick at screen coordinates stored in the ASubObject reference in the [AnObject] section of the current AppMap. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> ASubObject reference found in the AppMap [AnObject] section must contain the screen coordinates on which to click. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, DoubleClickScreenLocation</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> DoubleClick on the Window:AnObject screen coordinates. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Because no AppMapSubKey is provided the AnObject item MUST exist in the [WINDOW] section of the current AppMap and it MUST contain valid screen coordinate data. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_DoubleClickScreenPoint' />GenericObjectFunctions::<SPAN ID="deprecated">DoubleClickScreenPoint</SPAN> (deprecated for: <B>GenericObject DoubleClickScreenLocation</B>) <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Deprecated) DoubleClick a specified screen location. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> (Deprecated) DoubleClick a specified screen location. See <a href="#detail_DoubleClickScreenLocation">DoubleClickScreenLocation</a> for the preferred method to click on screen coordinates. <p> 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. </p><p> It is not recommended to hardcode screen coordinates in the test table in this way. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>Coords</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The hardcoded X,Y screen coordinates--or the result of an expression--that provides the absolute screen coordinates to click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The coordinates must be in the following supported formats: <p><pre> "33,120" (comma-delimited) OR "33;120" (semi-colon delimited) OR "33 120" (space-delimited) </pre></p><p> Note the "Coords=" prefix is NOT supported for this deprecated command. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, BogusWin, BogusComp, DoubleClickScreenPoint, 33;120</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> DoubleClick at screen coordinates 33,120. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> DoubleClick at screen coordinates 33,120 </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_DoubleTap' />GenericObjectFunctions::<BIG>DoubleTap</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A double-tap on a touchscreen object. Use keyword "DoubleClick" syntax and parameters. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ></OL ><B>Examples:</B><BR/><UL></UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_DragTo' />GenericObjectFunctions::<BIG>DragTo</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A left mouse drag is performed from one object to another object based on the offsets values. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>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.</p><p> The coordination specify by offsets value. First two values are for from-component and another are for to-component.</p><pre> Offsets can be 50%,50%,50%,50% or 50%;50%;50%;50% </pre><pre> 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. </pre></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>ToWindow</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> ToWindow object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>ToWindow recognition string define into AppMap.</p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B>ToComponent</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> ToComponent object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>ToComponent recognition string define into AppMap.</p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>Offsets</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Drag and release location of from-component and to-component. Offsets syntax will be "50%,50%,70%,70%, where first two percentages for from-component's X and Y location and second two are for to-component's X and Y location. If offsets isn't specify then center will be used." <p>Default value, both components center</p></short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p></p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>FromSubItem</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Text of from-component's sub item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>FromSubItem as text. e.g tree node or list item or any sub main component's item</p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>ToSubItem</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Text of to-component's sub item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>ToSubItem as text. e.g tree node or list item or any sub main component item</p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW,COMPONENT, DRAGTO, ToWINDOW,ToCOMPONENT</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A left mouse drag will be performed from component (COMPONENT) to to-component (ToCOMPONENT). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Drag the component from center and release on to-component's center. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW,COMPONENT, DRAGTO, ToWINDOW,ToCOMPONENT,"50%,50%,50%,50%"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A left mouse drag will be performed from component(X=50% and Y=50%) to to-component(X=50% and Y=50%). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 7 : "50%,50%,50%,50%" first two 50%s for component (COMPONENT) and another for to-component (ToCOMPONENT) drag and release point. User can use "," or ";" as separator to separate X and Y. example "50%,50%,50%,50%" or 50%;50%;50%;50%". </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW,COMPONENT, DRAGTO, WINDOW,COMPONENT,"50%;50%;75%;75%"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A left mouse drag will be performed to resize the component (COMPONENT) from 50% to 75% size. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Resize the component from (X=50%, y=50%) to X=75% and Y=75%. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW,COMPONENT, DRAGTO, ToWINDOW,ToCOMPONENT,"50%,50%,50%,50%","FromSubItem"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A left mouse drag will be performed from FromSubItem (COMPONENT's sub item) to to-component (ToCOMPONENT) using offsets(50%,50%,50%,50%). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 8 : FromSubItem of COMPONENT. It is useful when TreeNode or List Item drag to to-component. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW,COMPONENT, DRAGTO, ToWINDOW,ToCOMPONENT,50%,50%,50%,50%,"FromSubItem","ToSubItem"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A left mouse drag will be performed from FromSubItem (COMPONENT's sub item) to ToSubItem (ToCOMPONENT's sub item). </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 8 and 9: FromSubItem is a subitem of COMPONENT and ToSubItem is a subitem of ToCOMPONENT. It is useful when TreeNode or List Item drag to subitem of to-component. e.g DragTo tree node to list item. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_Flick' />GenericObjectFunctions::<BIG>Flick</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A user-defined flick or swipe on a touchscreen object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The user would use this command if they need to customize parameters like: <ul><li>Number of fingers used: default=1,</li><li>Start and ending offsets within the object: defaults=90;50;10;50</li><li>How long (in seconds) to complete the flick from start to end: default=1.</li></ul></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubKey</B> = 90;50;10;50 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional AppMap SubKey (or literal text) containing x1,y1,x2,y2 flick offsets within the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this we should perform a default right-to-left Flick. <p>Name of the AppMap subkey to lookup and use for the command. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":</p><pre> [ComponentName] OffsetName="0;0;100;100" </pre><p> Both Fields #3 (Component Name) and #5 (Offset Name) 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. </p><p> If no such App Map lookup exists, then we will assume the field contains the offset value directly. </p><p> Offsets are "relative" to the object. Each value should be an integer 0-100 representing the relative percentage where 0 is the minimum (left or top) and 100 is the maximum width or height of the object. Thus: 0,0,100,100 represents a flick from the topleft corner to the bottomright corner of the object. </p><p> Engines should attempt to support offsets separated by different characters. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "0,0,100,100" (topleft to bottomright)</li><li>";" (semi-colon) Example: "100;0;0;100" (topright to bottomleft)</li><li>" " (space) Example: "0 50 100 50" (leftcenter to rightcenter)</li></ul></p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>Duration</B> = 1 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional number of seconds (0 to N) to press on the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional number of seconds (0 to N) to press on the item. The default value is 1. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>Touches</B> = 1 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional number of touches or fingers to use. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional number of touches or fingers to use. The default value is 1. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>Repeat</B> = 1 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional number of times to repeat the operation. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional number of times to repeat the operation. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, Flick</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A simple flick on the object, from right-to-left with one touch/finger taking 1 second. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A simple flick on the object, from right-to-left with one touch/finger taking 1 second. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, MainApp, MyTree, Flick, TopRightToBottom</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A flick on the MyTree object using AppMapped offsets with one touch/finger taking 1 second. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A flick on the MyTree object with one touch/finger taking 1 second. The AppMap is intended to contains something like below: <p><pre> [MyTree] TopRightToBottom="90;0;90;100" </pre></p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, MainApp, MyTree, Flick, TopRightToBottom, 3</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A flick on the MyTree object using AppMapped offsets with one touch/finger taking 3 second. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A flick on the MyTree object using AppMapped offsets with one touch/finger taking 3 second. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, MainApp, MyTree, Flick, "", "", 2</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A simple right-to-left flick on the MyTree object taking 1 second with 2 fingers. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A simple right-to-left flick on the MyTree object taking 1 second with 2 fingers. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, MainApp, MyTree, Flick, "", "", "", 3</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> 3 simple right-to-left flicks on the MyTree object taking 1 second each. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 3 simple right-to-left flicks on the MyTree object taking 1 second each. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_FlickDown' />GenericObjectFunctions::<BIG>FlickDown</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A flick or swipe on a touchscreen object from top-to-bottom. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>Repeat</B> = 1 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional number of times to repeat the operation. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional number of times to repeat the operation. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, FlickDown</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A simple flick on the object from top-to-bottom. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A simple flick on the object from top-to-bottom. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, FlickDown, 3</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> 3 simple flicks on the object from top-to-bottom. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 3 simple flicks on the object from top-to-bottom. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_FlickLeft' />GenericObjectFunctions::<BIG>FlickLeft</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A flick or swipe on a touchscreen object from right-to-left. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>Repeat</B> = 1 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional number of times to repeat the operation. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional number of times to repeat the operation. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, FlickLeft</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A simple flick on the object from right-to-left. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A simple flick on the object from right-to-left. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, FlickLeft, 3</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> 3 simple flicks on the object from right-to-left. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 3 simple flicks on the object from right-to-left. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_FlickRight' />GenericObjectFunctions::<BIG>FlickRight</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A flick or swipe on a touchscreen object from left-to-right. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>Repeat</B> = 1 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional number of times to repeat the operation. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional number of times to repeat the operation. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, FlickRight</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A simple flick on the object from left-to-right. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A simple flick on the object from left-to-right. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, FlickRight, 3</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> 3 simple flicks on the object from left-to-right. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 3 simple flicks on the object from left-to-right. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_FlickUp' />GenericObjectFunctions::<BIG>FlickUp</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A flick or swipe on a touchscreen object from bottom-to-top. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>Repeat</B> = 1 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional number of times to repeat the operation. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional number of times to repeat the operation. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, FlickUp</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A simple flick on the object from bottom-to-top. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A simple flick on the object from bottom-to-top. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, FlickUp, 3</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> 3 simple flicks on the object from bottom-to-top. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 3 simple flicks on the object from bottom-to-top. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_HScrollTo' />GenericObjectFunctions::<BIG>HScrollTo</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Attempts to perform an HScrollTo on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Attempts to perform an HScrollTo on an object. The input record specifies the absolute position to scroll to. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>POSITION</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Integer value that specifies the absolute position to scroll to. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Integer value that specifies the absolute position to scroll to, as would be used in the "Position=%" parameter for the HScrollTo action of the SQABasic GenericObject command. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, Object, HSCROLLTO, 0</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Scrolls the object to the left most position. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, Object, HSCROLLTO, 10</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Scrolls the object to the absolute horizontal position of 10. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_JavaMenuSelect' />GenericObjectFunctions::<BIG>JavaMenuSelect</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Select a JAVA Menu Item according to a stored text value. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>Select a JAVA Menu Item according to a stored text value. Until JavaMenu objects are routed elsewhere, we will handle the menu selection here. Each menuItem acted upon is given a name in the AppMap under the name provided for the Menu.</p><p> The menuitem lookup is done with the component\menu name of the record AND Field #5.</p><p> Typical Data Table records:</p><p> t JavaWindow MainMenu JavaMenuSelect FileOpen </p><p> The example will contain a FileOpen="Path=File-&gt;Open" entry in the MainMenu section of the Application Map to select File-&gt;Open menuItem from the menu of the MainWindow.</p><p> MainMenu will also be an entry in the MainWindow section with normal recognition information for it. This will tell Robot to locate the MainMenu Generic Object prior to the menu selection.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>JavaMenuItem</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the Java menuitem to lookup and use for the selection. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>Name of the Java menuitem to lookup and use for the selection. We expect the AppMap to contain the item in the format "Path=Menu-&gt;Item":</p><p> [MainMenu] FileOpen="Path=File-&gt;Open"</p><p> The full results from the AppMap lookup are used, so any valid content used with the JavaMenu Click command can be part of this AppMap entry.</p><p> 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.</p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, MAINMENU, JavaMenuSelect, FileOpen</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A menu selection will be performed on the menuitem indicated by the FileOpen reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying the menuitem on which to click. This example shows FileOpen which will be found in the Application Map as a referenced item in the MAINMENU section. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_LeftDrag' />GenericObjectFunctions::<BIG>LeftDrag</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A left mouse drag is performed on the object based on the stored coordinates. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>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.</p><p> The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow GenericItem LeftDrag DragName</p><p> #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:</p><p><pre> DragName="15,30,60,90" OR DragName="Coords=15,30,60,90" </pre></p><p> This will tell Robot to locate the GenericItem Window object and left drag from coordinates 15,30 to 60,90.</p><p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>AppMapSubkey</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the AppMap subkey to lookup or literal text to use for the left mouse drag. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>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":</p><p><pre> [GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20" </pre></p><p> 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.</p><p> 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.</p><p><b>Important TID note.</b> The <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">TID IBT implementation</a> 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. </p><p> 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. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, LEFTDRAG, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A left mouse drag will be performed based on coordinates indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, LEFTDRAG, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A left mouse drag will be performed based on coordinates indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, LEFTDRAG, "Coords=10;20;200;300"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A left drag will be performed from point 10,20 to 200,300 relative to AnObject. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_MouseClick' />GenericObjectFunctions::<BIG>MouseClick</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on an object by mouse event. It uses low level mouse event to click on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> By default, mouse click on the center of the component. We can also mouse 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. </p><p> The object to be mouse clicked is first given context and then a mouse click is generated at the coordinates. Thus, a subitem or object can be referenced by name even though it is only recognized via coordinates. </p><p> 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.</p><p> Typical Data Table records:</p><p> (1) t MainWindow MainWindow MouseClick<br> (2) t MainWindow MainWindow MouseClick AnObject<br> (3) t MainWindow FolderTree MouseClick Node1<br> (4) t MainWindow MainWindow MouseClick "50,200"<br> (5) t MainWindow MainWindow MouseClick "Coords=50,200"</p><p> #2 above will contain an AnObject="3,10" entry in the MainWindow section of the Application Map to mouse click at x=3, y=10 in the MainWindow. </p><p> #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 mouse click at the coordinates specified by the reference. </p><p> #4 and #5 above show using literal text instead of an App Map entry to specify where to mouse click relative to the item. </p><p> 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. </p><p> 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. </p><p> This is the direction we expect all tools to follow going forward. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional)Name of the AppMap subkey to lookup or the literal text to use for the click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this we should click on the center of the object. <p>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":</p><pre> [FolderTree] Node1="33,120" OR Node1="Coords=33,120" ... [AnHTMLImage] AMappdedRegion=Coords=10,10 ANamedRegion=AreaName=TechSupport AnIndexedRegion=AreaIndex=2 AnotherRegion=AreaID=Contact </pre><p> The results from the lookup are appended to the "Coords=" string used by the MouseClick command in Robot (only if necessary). So any valid content used with the MouseClick command can be part of this AppMap entry.</p><p> 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. </p><p> 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. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, MOUSECLICK</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single mouse click on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on the center of the object. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, MOUSECLICK, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single mouse click will be performed at a x,y coordinate indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to click This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, MOUSECLICK, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single mouse click will be performed at a x,y coordinate indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to click This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, MOUSECLICK, 10;20</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single mouse click will be performed at coordinate 10,20 in the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, MOUSECLICK, "Coords=10;20"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single mouse click will be performed at coordinate 10,20 in the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_MultiClick' />GenericObjectFunctions::<BIG>MultiClick</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Multiple clicks on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> By default, clicks on the center of the component 3 times.<br> Use the optional ClickCount parameter to specify the desired number of clicks.<br> 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. </p><p> 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. </p><p> 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.</p><p> Typical Data Table records with relative references:</p><p> (1) t MainWindow MainWindow MultiClick <br> (2) t MainWindow MainWindow MultiClick AnObject<br> (3) t MainWindow FolderTree MultiClick Node1 "4"<br> (4) t MainWindow MainWindow MultiClick "50,200" "3"<br> (5) t MainWindow MainWindow MultiClick "Coords=50,200" "2"</p><p> #1 above should click 3 times (default) at the center (default) of the MainWindow. </p><p> #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. </p><p> #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. </p><p> #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 </p><p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional)Name of the AppMap subkey to lookup or the literal text to use for the clicks. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this we should click on the center of the object. <p>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":</p><pre> [FolderTree] Node1="33,120" OR Node1="Coords=33,120" ... [AnHTMLImage] AMappdedRegion=Coords=10,10 ANamedRegion=AreaName=TechSupport AnIndexedRegion=AreaIndex=2 AnotherRegion=AreaID=Contact </pre><p> 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.</p><p> 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. </p><p><b>Important TID note.</b> The <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">TID IBT implementation</a> 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. </p><p> 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. </p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>ClickCount</B> = 3 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional number of times (1 to N) to click the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional number of times (1 to N) to click the item. The default if no value is provided is 3. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, MULTICLICK</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click 3 times (default) on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Click 3 times (default) on the center of the object. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, MULTICLICK, "", "4"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click 4 times on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Click 4 times on the center of the object. No AppMapSubKey or Literal Text is given to alter the relative coordinates for the click. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, MULTICLICK, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click 3 times (default) at relative x,y coordinates stored in "AnObject" in the App Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. An item in the App Map holding relative coordinates to click.<br> This example shows "AnObject" which will be found in the App Map in the "WINDOW" section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, MULTICLICK, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click 3 times (default) at relative x,y coordinates stored in "ASubObject" in the App Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. An item in the App Map holding relative coordinates to click.<br> This example shows "ASubObject" which will be found in the App Map in the "COMPONENT" section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, MULTICLICK, 10;20</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click 3 times (default) at coordinate 10,20 in the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, MULTICLICK, "Coords=10;20", "4"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> 4 clicks at coordinate 10,20 in the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_MultiClickScreenImage' />GenericObjectFunctions::<BIG>MultiClickScreenImage</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Same as <a href="#detail_MultiClick" alt="Goto MultiClick">MULTICLICK</a>. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 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. <p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional)Name of the AppMap subkey to lookup or the literal text to use for the clicks. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Same as <a href="#detail_MultiClick" alt="Goto MultiClick">MULTICLICK</a>.<br> 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. <p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>ClickCount</B> = 3 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional number of times (1 to N) to click the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional number of times (1 to N) to click the item. The default if no value is provided is 3. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, MULTICLICKSCREENIMAGE</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click 3 times (default) on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Click 3 times (default) on the center of the object. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, MULTICLICKSCREENIMAGE, "", "4"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click 4 times on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Click 4 times on the center of the object. No AppMapSubKey or Literal Text is given to alter the relative coordinates for the click. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, MULTICLICKSCREENIMAGE, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click 3 times (default) at relative x,y coordinates stored in "AnObject" in the App Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. An item in the App Map holding relative coordinates to click.<br> This example shows "AnObject" which will be found in the App Map in the "WINDOW" section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, MULTICLICKSCREENIMAGE, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click 3 times (default) at relative x,y coordinates stored in "ASubObject" in the App Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. An item in the App Map holding relative coordinates to click.<br> This example shows "ASubObject" which will be found in the App Map in the "COMPONENT" section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, MULTICLICKSCREENIMAGE, 10;20</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Click 3 times (default) at coordinate 10,20 in the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, MULTICLICKSCREENIMAGE, "Coords=10;20", "4"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> 4 clicks at coordinate 10,20 in the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_Press' />GenericObjectFunctions::<BIG>Press</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='DRD.GIF' ALT='Android'/></TD> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Press a touchscreen object for a number of seconds--0 seconds by default. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>Duration</B> = 0 ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional number of seconds (0 to N) to press on the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional number of seconds (0 to N) to press on the item. The default if no value is provided is 0. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, Press</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A press on the object for less than 1 second. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A press on the object for less than 1 second. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, Press, 3</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A press on the object for 3 seconds. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A press on the object for 3 seconds. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_RightClick' />GenericObjectFunctions::<BIG>RightClick</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> <TD class="borderStyle"><IMG SRC='ABT.GIF' ALT='Abbot Commands'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A right click on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> By default we should click on the center of the object. <p>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.</p><p> The coordinate lookup is done with the component name of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow MainWindow RightClick <br> (2) t MainWindow MainWindow RightClick AnObject<br> (3) t MainWindow ToolItem RightClick PrintTool</p><p> #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.</p><p> #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. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p><p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) Name of the AppMap subkey to lookup or the literal text to use for the right click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this we should click on the center of the object. <p>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":</p><p><pre> [ToolItem] PrintTool="33,120" OR PrintTool="Coords=33,120" </pre></p><p> 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.</p><p> 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. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p><p><b>Important TID note.</b> The <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">TID IBT implementation</a> 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. </p><p> 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. </p><p><b>Important Abbot note.</b> Presently, there is no support for AppMapSubkey specification (5th field). </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, RIGHTCLICK</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A right click will be performed on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A right click will be performed on the center of the object. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, RIGHTCLICK, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A right click will be performed at a x,y coordinate indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to right-click This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, RIGHTCLICK, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A right click will be performed at a x,y coordinate indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to right-click This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, RIGHTCLICK, "Coords=10;20"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single right click will be performed at coordinate 10,20 in the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_RightClickScreenImage' />GenericObjectFunctions::<BIG>RightClickScreenImage</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Same as RightClick. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 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. <p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubKey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) AppMapSubKey or literal text as documented in the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, RightClickScreenImage</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A right-click as generically documented for the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A right-click as generically documented for the CLICK command. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, RightClickScreenImage, "Coords=10;20"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A right click as generically documented for the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_RightClickScreenLocation' />GenericObjectFunctions::<BIG>RightClickScreenLocation</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> RightClick a specified screen location. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> RightClick a specified screen location. <p>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. </p><p> 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. </p><p> 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. </p><p> Any AppMapSubKey lookup is done with the Component name in the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow Component RightClickScreenLocation<br> (2) t MainWindow MainWindow RightClickScreenLocation AnObject<br> (3) t MainWindow MainWindow RightClickScreenLocation 50,80<br> (4) t AnyWin AnyComp RightClickScreenLocation Node1</p><p> #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.</p><p> #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.</p><p> #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.</p><p> #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.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Sometimes Optional)Name of the AppMap subkey to locate in the AppMap. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this there MUST be absolute screen coordinates stored in the AppMap for the Window:Component specified. <p> Name of the AppMap subkey to locate in the App Map. We expect the AppMap to contain the coordinates in the following supported formats: </p><p><pre> [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) </pre></p><p> 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.</p><p> This field can instead contain the literal text of any absolute or relative coordinates in the same formats as shown above. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, RightClickScreenLocation</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> RightClick at specified screen coordinates for WINDOW. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> RightClick at screen coordinates specified for the Window item stored in the [Window] section of the current AppMap. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, RightClickScreenLocation, "Coords=200,400"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> RightClick at screen coordinates 200,400. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> RightClick at screen coordinates 200,400. This assumes AnObject is NOT an item in the [Window] section of the current AppMap with valid coordinate data. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, RightClickScreenLocation, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> RightClick at screen coordinates stored in the ASubObject reference in the [AnObject] section of the current AppMap. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> ASubObject reference found in the AppMap [AnObject] section must contain the screen coordinates on which to click. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, RightClickScreenLocation</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> RightClick on the Window:AnObject screen coordinates. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Because no AppMapSubKey is provided the AnObject item MUST exist in the [WINDOW] section of the current AppMap and it MUST contain valid screen coordinate data. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_RightClickScreenPoint' />GenericObjectFunctions::<SPAN ID="deprecated">RightClickScreenPoint</SPAN> (deprecated for: <B>GenericObject RightClickScreenLocation</B>) <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Deprecated) RightClick a specified screen location. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> (Deprecated) RightClick a specified screen location. See <a href="#detail_RightClickScreenLocation">RightClickScreenLocation</a> for the preferred method to click on screen coordinates. <p> 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. </p><p> It is not recommended to hardcode screen coordinates in the test table in this way. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>Coords</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The hardcoded X,Y screen coordinates--or the result of an expression--that provides the absolute screen coordinates to click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The coordinates must be in the following supported formats: <p><pre> "33,120" (comma-delimited) OR "33;120" (semi-colon delimited) OR "33 120" (space-delimited) </pre></p><p> Note the "Coords=" prefix is NOT supported for this deprecated command. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, BogusWin, BogusComp, RightClickScreenPoint, 33;120</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> RightClick at screen coordinates 33,120. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> RightClick at screen coordinates 33,120 </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_RightDrag' />GenericObjectFunctions::<BIG>RightDrag</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A right mouse drag is performed on the object based on the stored coordinates. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>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.</p><p> The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow GenericItem RightDrag DragName</p><p> #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:</p><p> DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"</p><p> This will tell Robot to locate the GenericItem Window object and right drag from coordinates 15,30 to 60,90.</p><p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>AppMapSubkey</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the AppMap subkey to lookup or literal text to use for the right mouse drag. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>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":</p><p><pre> [GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20" </pre></p><p> 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.</p><p> 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.</p><p><b>Important TID note.</b> The <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">TID IBT implementation</a> 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. </p><p> 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. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, RIGHTDRAG, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A right mouse drag will be performed based on coordinates indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, LEFTDRAG, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A right mouse drag will be performed based on coordinates indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, RIGHTDRAG, "Coords=10;20;200;300"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A right drag will be performed from point 10,20 to 200,300 relative to AnObject. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_ShiftClick' />GenericObjectFunctions::<BIG>ShiftClick</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> <TD class="borderStyle"><IMG SRC='TC.GIF' ALT='AutomatedQA Test Complete'/></TD> <TD class="borderStyle"><IMG SRC='WR.GIF' ALT='Mercury Interactive WinRunner'/></TD> <TD class="borderStyle"><IMG SRC='ABT.GIF' ALT='Abbot Commands'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A SHIFT click on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> By default we should click on the center of the object. <p>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.</p><p> The coordinate lookup is done with the component name of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow MainWindow ShiftClick <br> (2) t MainWindow MainWindow ShiftClick AnObject<br> (3) t MainWindow ToolItem ShiftClick PrintTool</p><p> #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.</p><p> #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. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubkey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) Name of the AppMap subkey to lookup and use for the SHIFT click. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Without this we should click on the center of the object. <p>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":</p><p><pre> [ToolItem]<br> PrintTool="33,120" OR PrintTool="Coords=33,120" </pre></p><p> 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.</p><p> 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. </p><p> Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be: <ul><li>"," (comma) Example: "50,200"</li><li>";" (semi-colon) Example: "50;200"</li><li>" " (space) Example: "50 200"</li></ul></p><p><b>Important Abbot note.</b> Presently, there is no support for AppMapSubkey specification (5th field). </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, SHIFTCLICK</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A SHIFT click will be performed on the center of the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A SHIFT click will be performed on the center of the object. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, SHIFTCLICK, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A SHIFT click will be performed at a x,y coordinate indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to SHIFT-click This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, SHIFTCLICK, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A SHIFT click will be performed at a x,y coordinate indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to SHIFT-click This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_ShiftClickScreenImage' />GenericObjectFunctions::<BIG>ShiftClickScreenImage</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='TID.GIF' ALT='SAFS TID Commands'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Same as ShiftClick. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> 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. <p> Note: the TID supports this command using <a href="http://safsdev.sourceforge.net/sqabasic2000/SAFSImageBasedRecognition.htm" target="imagebased" alt="SAFS Image-Based Recognition Doc">Image-Based Testing</a> techniques and App Map entries as well as literal text coordinates. </p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI>[ <B>AppMapSubKey</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> (Optional) AppMapSubKey type of use as documented in the CLICK command. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, ShiftClickScreenImage</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on the center of the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on the center of the item with SHIFT key pressed. Refer to the SHIFTCLICK command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, ShiftClickScreenImage, AppMapLookup</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on a point relative to the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on a point relative to the item with SHIFT key pressed. Refer to the SHIFTCLICK command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, ShiftClickScreenImage, "Coords=50;200"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single click on a point relative to the item. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A single click on a point relative to the item with SHIFT key pressed. Refer to the SHIFTCLICK command for details. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_ShiftLeftDrag' />GenericObjectFunctions::<BIG>ShiftLeftDrag</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A SHIFT left mouse drag is performed on the object based on the stored coordinates. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p> The coordinate lookup is done with the component name(Field #3) of the record AND Field #5.</p><p> Typical Data Table records:</p><p> (1) t MainWindow GenericItem ShiftLeftDrag DragName</p><p> #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:</p><p> DragName="15,30,60,90" OR DragName="Coords=15,30,60,90"</p><p> This will tell RFT to locate the GenericItem Window object and SHIFT left drag from coordinates 15,30 to 60,90.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>AppMapSubkey</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the AppMap subkey to lookup or literal text to use for the SHIFT left mouse drag. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>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":</p><p><pre> [GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20" </pre></p><p> 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. </p></detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, WINDOW, SHIFTLEFTDRAG, AnObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A SHIFT left mouse drag will be performed based on coordinates indicated by the AnObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject which will be found in the Application Map as a referenced item in the WINDOW section. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, SHIFTLEFTDRAG, ASubObject</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A SHIFT left mouse drag will be performed based on coordinates indicated by the ASubObject reference in the Application Map. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. A reference identified in the Application Map identifying coordinates on which to drag. This example shows AnObject as a viable object in the WINDOW but that it also has its own section in the Application Map which contains one or more named references like ASubObject which are used for test. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, AnObject, SHIFTLEFTDRAG, "Coords=10;20;200;300"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A SHIFT left drag will be performed from point 10,20 to 200,300 relative to AnObject. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The item does not exist in the app map so will be treated as literal text. Note we allow semi-colon delimited coordinates to support the case when commas are used as field delimiters and cannot be used to delimite the X and Y coordinates. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_Tap' />GenericObjectFunctions::<BIG>Tap</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='DRD.GIF' ALT='Android'/></TD> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A single Tap on a touchscreen object. Use keyword "Click" syntax and parameters. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ></OL ><B>Examples:</B><BR/><UL></UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_TwoFingerTap' />GenericObjectFunctions::<BIG>TwoFingerTap</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='IOS.GIF' ALT='Apple IOS'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A two-finger tap on a touchscreen object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, COMPONENT, TwoFingerTap</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> A two-fingered tap on the object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> A two-fingered tap on the object. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_VerifyImage' />GenericObjectFunctions::<BIG>VerifyImage</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a GenericObjectVP CompareImage OR a RegionImageVP on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>Performs a GenericObjectVP CompareImage OR a RegionImageVP on an object. The benchmark VP must already exist and be an asset of the currently running script.</p><p> A RegionImageVP can be accomplished by having the name of the VP as an item under the component in the application map. The item's value must be the coordinate values required by the RegionImageVP (i.e. "65,100,200,250").</p><p> Example 1: Perform a GenericObjectVP CompareImage</p><p> MainWindow SomeGenericObject VerifyImage StoredVP</p><p> (no StoredVP item found in the app map under SomeGenericObject)</p><p> The named VP (StoredVP) must not exist in the application map. The entire panel/object of SomeGenericObject will be captured and compared against the StoredVP baseline which must already exist as an asset of the currently running script.</p><p> Example 2: Perform a RegionImageVP on a particular area of the screen</p><p> MainWindow SomeGenericObject VerifyImage StoredVP</p><pre> (StoredVP found as: "65,100,200,250" OR "Coords=65,100,200,250" </pre><p> in the SomeGenericObject section of the app map)</p><p> The named VP (StoredVP) is found to exist in the application map as a subitem in the SomeGenericObject section of the map. This causes the routine to attempt a RegionImageVP using the map's value of the StoredVP item as the coordinates for the region to capture. StoredVP is ALSO the name of the VP which must already exist as an asset of the currently running script.</p></detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>VPAsset</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the pre-existing VP asset stored in the currently running script. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then a RegionImageVP will be attempted. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, AnObject, VERIFYIMAGE, "AStoredVP"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> This action verifies the AnObject image against the "AStoredVP" benchmark. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The name of a stored VP which must exist as an asset of the currently running script. Normally, a straight Robot CompareImage of the entire object would be performed. However, if the AStoredVP value given exists in the Application Map as a reference under the provided Component Object then a RegionImage test will be attempted instead. </detailed_desc><BR/> </DIV> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> <H3><A NAME='detail_VScrollTo' />GenericObjectFunctions::<BIG>VScrollTo</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='RJ.GIF' ALT='Rational RobotJ'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Attempts to perform a VScrollTo on an object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Attempts to perform a VScrollTo on an object. The input record specifies the absolute position to scroll to. </detailed_desc><BR/> </DIV> <BR/> <DIV NAME="list" ID="other"> <B>Fields: [ ]</B>=<SMALL>Optional with Default Value</SMALL><BR/> <OL start="5" ><LI> <B>POSITION</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Integer value that specifies the absolute position to scroll to. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Integer value that specifies the absolute position to scroll to, as would be used in the "Position=%" parameter for the VScrollTo action of the SQABasic GenericObject command. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WINDOW, Object, VSCROLLTO, 0</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Scrolls the object to the top most position. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> <LI> <B><usage xmlns="">T, WINDOW, Object, VSCROLLTO, 10</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Scrolls the object to the absolute vertical position of 10. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/> </UL> <A href="SAFSReferenceKey.htm" alt="Reference Legend or Key"> <SMALL><B>[How To Read This Reference]</B></SMALL> </A> <HR/></DIV> </DIV> </BODY> </HTML>