HTMLLinkFunctions

Last Updated:

Actions for working with HTMLLink objects


[How To Read This Reference]
Click
WR
Deprecated For:Generic CLICK
CompareStoredData
WR
Deprecated For:Generic CompareStoredData
CompareStoredProperties
WR
Deprecated For:Generic CompareStoredProperties

HTMLLinkFunctions::Click (deprecated for: Generic CLICK)
WR

Use Generic CLICK where possible.

Attempts to perform a standard Click on an HTMLLink on a webpage.

Example:

BrowserWin SomeLink Click



Fields: [ ]=Optional with Default Value
    Examples:
    • T, WebBrowser, URLLink, CLICK
      A single-click is performed on the URLLINK

      A single-click is performed on the URLLINK

    [How To Read This Reference]

    HTMLLinkFunctions::CompareStoredData (deprecated for: Generic CompareStoredData)
    WR

    Performs a HTMLLinkVP CompareData on an HTMLLink object.

    Performs a HTMLLinkVP CompareData on an HTMLLink object.

    THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY RUNNING SCRIPT.

    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 HTMLLink. 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.

    Example 1: Perform a standard HTMLLink CompareData. To perform a basic CompareData the name "StoredVP" will not exist in the app map:

    The Step File call:

    BrowserWindow AnHTMLLink CompareStoredData StoredVP

    This will produce a CompareData VP with "VP=StoredVP;Wait=2,10".

    The StoredVP baseline MUST already exist as an asset of the currently running script.

    Example 2: Perform a HTMLLink CompareData providing addition parameter information (such as ExpectedResult=FAIL). To do this the HTMLLink 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.

    Part of App Map:

    [BrowserWindow] BrowserWindow=WindowTag=WEBBrowser AnHTMLLink=<snipped for brevity>;\;Type=HTMLLink;HTMLID=LinkID ... [AnHTMLLink] StoredVP=ExpectedResult=FAIL;Wait=3,30

    The Step File call:

    BrowserWindow AnHTMLLink CompareStoredData StoredVP

    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.

    The StoredVP baseline MUST already exist as an asset of the currently running script.



    Fields: [ ]=Optional with Default Value
    1. VPAsset
      Name of the pre-existing VP asset stored in the currently running script.

      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.

    Examples:
    • T, WebBrowser, URLLink, COMPARESTOREDDATA, "AStoredVP"
      This action compares stored data on the URLLink object against "AStoredVP".

      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.

      [URLLink]

      AStoredVP=ExpectedResult=FAIL;Wait=3,30



    [How To Read This Reference]

    HTMLLinkFunctions::CompareStoredProperties (deprecated for: Generic CompareStoredProperties)
    WR

    Performs a HTMLLinkVP CompareProperties on an HTMLLink object.

    Performs a HTMLLinkVP CompareProperties on an HTMLLink object.

    THE BENCHMARK VP MUST ALREADY EXIST AND BE AN ASSET OF THE CURRENTLY RUNNING SCRIPT.

    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 HTMLLink. 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.

    Example 1: Perform a standard HTMLLink CompareProperties. To perform a basic CompareProperties the name "StoredVP" will not exist in the app map:

    The Step File call:

    BrowserWindow AnHTMLLink CompareStoredProperties StoredVP

    This will produce a CompareProperties VP with "VP=StoredVP;Wait=2,10".

    The StoredVP baseline MUST already exist as an asset of the currently running script.

    Example 2: Perform a HTMLLink CompareProperties providing addition parameter information (such as ExpectedResult=FAIL). To do this the HTMLLink 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.

    Part of App Map:

    [BrowserWindow] BrowserWindow=WindowTag=WEBBrowser AnHTMLLink=<snipped for brevity>;\;Type=HTMLLink;HTMLID=LinkID ... [AnHTMLLink] StoredVP=ExpectedResult=FAIL;Wait=3,30

    The Step File call:

    BrowserWindow AnHTMLLink CompareStoredProperties StoredVP

    This will produce a CompareProperties 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.

    The StoredVP baseline MUST already exist as an asset of the currently running script.



    Fields: [ ]=Optional with Default Value
    1. VPAsset
      Name of the pre-existing VP asset stored in the currently running script.

      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.

    Examples:
    • T, WebBrowser, URLLink, COMPARESTOREDPROPERTIES, "AStoredVP"
      This action performs a CompareProperties on the WebLink object against "AStoredVP".

      Field 5 : TQ String. The name of a stored CompareProperties 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.

      [URLLink]

      AStoredVP=ExpectedResult=FAIL;Wait=3,30



    [How To Read This Reference]