ÿþ<HTML xmlns="http://www.w3.org/TR/REC-html40"> <HEAD> <TITLE>HTMLDocumentFunctions</TITLE> <LINK rel="stylesheet" href="rrafs.css" type="text/css"/> </HEAD> <BODY> <DIV NAME="top" ID="top"> <H3>HTMLDocumentFunctions</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 HTMLDocument objects </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </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_CaptureBodySourceToFile' HREF='#detail_CaptureBodySourceToFile' >CaptureBodySourceToFile</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> Captures the HTML source of the BODY tag into a file. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_CaptureBodyTextToFile' HREF='#detail_CaptureBodyTextToFile' >CaptureBodyTextToFile</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> Captures the visible document text into a file. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ClickLink' HREF='#detail_ClickLink' >ClickLink</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> Performs an HTMLLink Click based on a complete match of text found on Links within this HTMLDOCUMENT object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ClickLinkBeginning' HREF='#detail_ClickLinkBeginning' >ClickLinkBeginning</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_ClickLinkContaining' HREF='#detail_ClickLinkContaining' >ClickLinkContaining</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD> Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A ID="linkdeprecated" NAME='list_ClickLinkMatching' HREF='#detail_ClickLinkMatching' >ClickLinkMatching</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </TD> <TD>Deprecated For:ClickLink</TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_VerifyBodySource' HREF='#detail_VerifyBodySource' >VerifyBodySource</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RCW.GIF' ALT='Rational Robot Classic'/></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> Compares the HTML source of the BODY tag with that of a benchmark file. </TD> </TR> <TR> <TD nowrap="true" width="27%"><A NAME='list_VerifyBodyText' HREF='#detail_VerifyBodyText' >VerifyBodyText</A></TD><TD width="12%" align="CENTER"> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RCW.GIF' ALT='Rational Robot Classic'/></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> Compares the visible doc text with that of a benchmark file. </TD> </TR> </TABLE> <HR/> </DIV> <DIV NAME="detail" ID="detail"> <H3><A NAME='detail_CaptureBodySourceToFile' />HTMLDocumentFunctions::<BIG>CaptureBodySourceToFile</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Captures the HTML source of the BODY tag into a file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Captures the HTML source of the BODY tag into a file.<br> This includes the BODY tag itself, everything inside it, and the closing /Body tag as well. <p><B>RobotJ (RJ) Specific Notes:</B><br> 1) If your HTML document or browser does not support the 'outerHTML' property then you may have to resort to providing internet connection info in the properties file mentioned in #2. <p></p> 2) If you use proxy to connect to internet, proxy.server and proxy.server.port in the file org.safs.rational.proxyParameter.properties must be set to ensure the execution of this command. </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>Filename</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the output file to create in the active "Test" directory. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Name of the output file to create in the active "Test" directory. This is the name only, no path information is expected. If the file extension is omitted then the default extension of ".TXT" will be used. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>FileEncoding</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CaptureBodySourceTofile, OutputFile</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Stores the text within the BODY tag to OutputFile.TXT </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. Filename of the output file in the active "Test" directory. If no extension is provided then .TXT is assumed. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CaptureBodySourceTofile, OutputFile, "UTF-8"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Stores the text within the BODY tag to OutputFile.TXT </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. Filename of the output file in the active "Test" directory. If no extension is provided then .TXT is assumed.<BR> Write the file with "UTF-8" encoding. </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_CaptureBodyTextToFile' />HTMLDocumentFunctions::<BIG>CaptureBodyTextToFile</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Captures the visible document text into a file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Captures the visible document text into a file.<br> That is, generally, the text you see with no HTML tags. /Body tag as well. </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>Filename</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the output file to create in the active "Test" directory. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Name of the output file to create in the active "Test" directory. This is the name only, no path information is expected. If the file extension is omitted then the default extension of ".TXT" will be used. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>FileEncoding</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CaptureBodyTextTofile, OutputFile</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Stores the visible text to OutputFile.TXT </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. Filename of the output file in the active "Test" directory. If no extension is provided then .TXT is assumed. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CaptureBodyTextTofile, OutputFile, "UTF-8"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Stores the visible text to OutputFile.TXT </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. Filename of the output file in the active "Test" directory. If no extension is provided then .TXT is assumed.<br> Writing file with "UTF-8" encoding. </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_ClickLink' />HTMLDocumentFunctions::<BIG>ClickLink</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs an HTMLLink Click based on a complete match of text found on Links within this HTMLDOCUMENT object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>Performs an HTMLLink Click based on a complete match of text found on Links within this HTMLDOCUMENT object.</p><p> Optionally, the user can also specify a match index to indicate that the desired Link is the "nth" Link that matches the text criteria.</p><p> The text comparison for the Link is NOT case-sensitive by default.</p><p> Leading and trailing whitespace will be removed from the links as they are compared unless the link in the HTML itself is quoted. In addition, any Line Feeds and Carriage Returns will be removed. For the link, we use the outerText property to locate the text.</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>CompareTextValue</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The text to compare with each Link. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The text to compare with each Link. By default this comparison is not case-sensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>MatchIndex</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. The index is 1-based. "1" selects the first matching link, "2" selects the second matching link, etc.. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>CaseSensitive</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CLICKLINK, "Yearly Reports"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on the HTMLLink that contains "Yearly Reports" in the document. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The case-insensitive text to match and click </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CLICKLINK, "Yearly Reports", 1, "CaseSensitive"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on the HTMLLink that contains "Yearly Reports" in the document. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : The text to match and click<br> Field [6]: The first link that matches.<br> Field [7]: The search is case-sensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CLICKLINK, "Yearly Reports", 4</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on the 4th HTMLLink that matches "Yearly Reports" in the document. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The case-insensitive text to match and click<br> Field [6]: TQ String. The match index to select if more than one link would match and you don't want the first one </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_ClickLinkBeginning' />HTMLDocumentFunctions::<BIG>ClickLinkBeginning</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object. The text of the Link is expected to BEGIN with the text provided by the user. Optionally, the user can also specify a match index to indicate that the desired Link is the "nth" Link that matches the text criteria.</p><p> The text comparison for the Link is NOT case-sensitive by default. The user can specify a case-senstive comparison via CaseSensitive Field #7. </p><p> Leading and trailing whitespace will be removed from the links as they are compared unless the link in the HTML itself is quoted. In addition, any Line Feeds and Carriage Returns will be removed. For the link, we use the outerText property to locate the text.</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>BeginningTextValue</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The text (NOT case-sensitive) to compare with the beginning of each Link. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The text (NOT case-sensitive) to compare with the beginning of each Link. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>MatchIndex</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. The index is 1-based. "1" selects the first matching link, "2" selects the second matching link, etc.. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>CaseSensitive</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CLICKLINKBEGINNING, "Report Generated on"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on HTMLLinks that begin with "Report Generated on" on WebPage document </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The case-insensitive text to match and click </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CLICKLINKBEGINNING, "Report Generated on", 4</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on the 4th HTMLLink match beginning with "Report Generated on" on WebPage document </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The case-insensitive text to match and click<br> Field [6]: TQ String. The match index to select if more than one link would match and you don't want the first one </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CLICKLINKBEGINNING, "Report", 1, ^CaseSensitive="TRUE"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on the 1st HTMLLink match beginning with "Report" on WebPage document. This time the link text comparison IS case-sensitive. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The text to match and click<br> Field [6]: TQ String. The match index to select if more than one link would match and you don't want the first one Field [7]: TQ String. "Case-Sensitive", "CaseSensitive", or "True" to make the match case-sensitive. </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_ClickLinkContaining' />HTMLDocumentFunctions::<BIG>ClickLinkContaining</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='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""><p>Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object. The text of the Link is expected to CONTAIN the text provided by the user at any position in the Link text--not strictly the beginning as in ClickLinkBeginning.</p><p> Optionally, the user can also specify a match index to indicate that the desired Link is the "nth" Link that matches the text criteria.</p><p> The text comparison for the Link is NOT case-sensitive by default.</p><p> Leading and trailing whitespace will be removed from the links as they are compared unless the link in the HTML itself is quoted. In addition, any Line Feeds and Carriage Returns will be removed. For the link, we use the outerText property to locate the text.</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>CompareTextValue</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The text to compare with each Link. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The text (NOT case-sensitive) to compare with each Link. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>MatchIndex</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. The index is 1-based. "1" selects the first matching link, "2" selects the second matching link, etc.. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>CaseSensitive</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CLICKLINKCONTAINING, "Yearly Reports"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on HTMLLinks that contains "Yearly Reports" on WebPage document </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The case-insensitive text to match and click </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CLICKLINKCONTAINING, "Yearly Reports", 1, "CaseSensitive"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on HTMLLinks that contains "Yearly Reports" on WebPage document </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : The text to match and click<br> Field [6]: The first link that matches.<br> Field [7]: The search is case-sensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, CLICKLINKCONTAINING, "Yearly Reports", 4</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on the 4th HTMLLink match that contains "Yearly Reports" on WebPage document </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The case-insensitive text to match and click<br> Field [6]: TQ String. The match index to select if more than one link would match and you don't want the first one </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_ClickLinkMatching' />HTMLDocumentFunctions::<SPAN ID="deprecated">ClickLinkMatching</SPAN> (deprecated for: <B>ClickLink</B>) <TABLE><TR> <TD class="borderStyle"><IMG SRC='RC.GIF' ALT='Rational Robot Classic'/></TD> <TD class="borderStyle"><IMG SRC='SE.GIF' ALT='Selenium'/></TD> </TR></TABLE> </H3> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> DEPARECATED. This command is identical to ClickLink. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> DEPARECATED. This command is identical to ClickLink. </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>CompareTextValue</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> The text to compare with each Link. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The text to compare with each Link. By default this comparison is not case-sensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>MatchIndex</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. The index is 1-based. "1" selects the first matching link, "2" selects the second matching link, etc.. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>CaseSensitive</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive. </detailed_desc><BR/> </DIV> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, ClickLinkMatching, "Yearly Reports"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on the HTMLLink that contains "Yearly Reports" in the document. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The case-insensitive text to match and click </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, ClickLinkMatching, "Yearly Reports", 1, "CaseSensitive"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on the HTMLLink that contains "Yearly Reports" in the document. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : The text to match and click<br> Field [6]: The first link that matches.<br> Field [7]: The search is case-sensitive. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, ClickLinkMatching, "Yearly Reports", 4</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs a single click on the 4th HTMLLink that matches "Yearly Reports" in the document. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. The case-insensitive text to match and click<br> Field [6]: TQ String. The match index to select if more than one link would match and you don't want the first one </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_VerifyBodySource' />HTMLDocumentFunctions::<BIG>VerifyBodySource</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RCW.GIF' ALT='Rational Robot Classic'/></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=""> Compares the HTML source of the BODY tag with that of a benchmark file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> This includes the BODY tag itself, everything inside it, and the closing /Body tag as well. <p> RRAFS:<br> The routine will automatically create a temporary ObjectData VP with a dummy baseline, capture the actual file, transfer it to active "Test" directory, and compare it with the benchmark. The routine will then delete all significant remnants of the temporary ObjectData VP.</p><p> RRAFS:<br> This routine requires that the following two files exist in the DDE_RUNTIME directory:</p><p> HTMLDocumentHTML.grd<br> HTMLDocumentHTML.vpm</p><p> The command may produce a WARNING if a diff tool for which we have no means to verify the results is configured for use. Consequently, if these warnings are expected, the user can use the "TW" test record type to avoid issuing these warnings.</p><p><B>RobotJ (RJ) Specific Notes:</B><br> 1) If you use proxy to connect to internet, proxy.server and proxy.server.port in the file org.safs.rational.proxyParameter.properties must be set to ensure the execution of this command. </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>Benchmark</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison. This is the name only, no path information is expected. If the file extension is omitted then the default extension of ".TXT" will be used. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>FileEncoding</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, VERIFYBODYSOURCE, BenchmarkFile.TXT</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs action compares the text within the BODY tag to the BenchmarkFile.TXT </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. Filename of the Benchmark file in the active "Bench" directory. If no extension is provided then .TXT is assumed. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, VERIFYBODYSOURCE, BenchmarkFile.TXT, "UTF-8"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs action compares the text within the BODY tag to the BenchmarkFile.TXT </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. Filename of the Benchmark file in the active "Bench" directory. If no extension is provided then .TXT is assumed.<BR> Opening the bench file with "UTF-8" encoding. </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_VerifyBodyText' />HTMLDocumentFunctions::<BIG>VerifyBodyText</BIG> <TABLE><TR> <TD class="borderStyle"><IMG SRC='RCW.GIF' ALT='Rational Robot Classic'/></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=""> Compares the visible doc text with that of a benchmark file. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> The routine will automatically create a temporary ObjectData VP with a dummy baseline, capture the actual file, transfer it to active "Test" directory, and compare it with the benchmark. The routine will then delete all significant remnants of the temporary ObjectData VP. <p> This routine requires that the following two files exist in the DDE_RUNTIME directory:</p><p> HTMLDocumentText.grd HTMLDocumentText.vpm</p><p> The command may produce a WARNING if a diff tool for which we have no means to verify the results is configured for use. Consequently, if these warnings are expected, the user can use the "TW" test record type to avoid issuing these warnings.</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>Benchmark</B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison. This is the name only, no path information is expected. If the file extension is omitted then the default extension of ".TXT" will be used. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI>[ <B>FileEncoding</B> = ]<BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead. </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"/> </LI> <BR/></OL ><B>Examples:</B><BR/><UL> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, VERIFYBODYTEXT, BenchmarkFile.TXT</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs action compares text to the BenchmarkFile.TXT </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. Filename of the Benchmark file in the active "Bench" directory. If no extension is provided then .TXT is assumed. </detailed_desc><BR/> </DIV> </LI> <BR/> <LI> <B><usage xmlns="">T, WebBrowser, WebPage, VERIFYBODYTEXT, BenchmarkFile.TXT, "UTF-8"</usage></B> <BR/> <DIV NAME="list" ID="short_desc"><short_desc xmlns=""> Performs action compares text to the BenchmarkFile.TXT </short_desc></DIV> <BR/> <DIV NAME="list" ID="detail_desc"><detailed_desc xmlns=""> Field 5 : TQ String. Filename of the Benchmark file in the active "Bench" directory. If no extension is provided then .TXT is assumed.<BR> Opening the bench file with "UTF-8" encoding. </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> </DIV> </BODY> </HTML>