TabControlFunctions

Last Updated:

Actions for working with TabControl objects


[How To Read This Reference]
Click
WR
Deprecated For:ClickTab
ClickTab
RC RJ WR TC DRD SE2
Attempts to perform a standard Click on a particular Tab on the TabControl
ClickTabContains
RJ TC DRD SE2
Attempts to perform a Click on a Tab according to a partial match of its text value.
MakeSelection
RC RJ WR TC DRD SE2
Attempts to perform a standard Click on a particular Tab on the TabControl
SelectTab
RC RJ WR TC DRD SE2
Attempts to perform a standard SelectTab on a particular Tab on the TabControl
SelectTabIndex
RC RJ TC DRD SE2
Attempts to select a particular Tab by Index.
UnverifiedClick
WR
Deprecated For:UnverifiedClickTab
UnverifiedClickTab
RC RJ TC DRD SE2
Attempts to perform an unverified Click on a particular Tab on the TabControl

TabControlFunctions::Click (deprecated for: ClickTab)
WR

Use ClickTab instead (where available).

Attempts to perform a standard Click on a particular Tab on the TabControl. The routine will set the StepDriverTestInfo.statuscode and log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text* on the tab to identify which tab to click.

    TextValue is the case-sensitive text on the tab to identify which tab to click. *For Sheridan SSActiveTabs this will be treated as an AppMap reference to an item that contains coordinates in the form of "xcoord,ycoord". The item will be retrieved from the section in the AppMap with the Components name (Field #3).

  2. [ process = ]
    Indicator for unverified click.

    When process=1, this indicates we are performing an unverified click.

Examples:
  • T, WINDOW, TabControl, CLICK, "StatsTab"
    A single-click is performed on the "StatsTab" tab located on the TabControl object.

    A single-click is performed on the "StatsTab" tab located on the TabControl object. For Sheridan SSActiveTabs this click location is determined by coordinates stored in the AppMap. Given the example, the AppMap will contain the following entry:

    [TabControl]
    StatsTab="100, 12"



[How To Read This Reference]

TabControlFunctions::ClickTab
RC RJ WR TC DRD SE2

Attempts to perform a standard Click on a particular Tab on the TabControl

Attempts to perform a standard Click on a particular Tab on the TabControl. The routine will set the StepDriverTestInfo.statuscode and log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text on the tab to identify which tab to click.

    TextValue is the case-sensitive text on the tab to identify which tab to click. *For Sheridan SSActiveTabs this will be treated as an AppMap reference to an item that contains coordinates in the form of "xcoord,ycoord". The item will be retrieved from the section in the AppMap with the Components name (Field #3).

Examples:
  • T, WINDOW, TabControl, CLICKTAB, "StatsTab"
    A single-click is performed on the "StatsTab" tab located on the TabControl object.

    A single-click is performed on the "StatsTab" tab located on the TabControl object. For Sheridan SSActiveTabs this click location is determined by coordinates stored in the AppMap. Given the example, the AppMap will contain the following entry:

    [TabControl]
    StatsTab="100, 12"



[How To Read This Reference]

TabControlFunctions::ClickTabContains
RJ TC DRD SE2

Attempts to perform a Click on a Tab according to a partial match of its text value.

Attempts to perform a Click on a Tab according to a partial match of its text value. The routine will set the StepDriverTestInfo.statuscode and log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.

Note: this keyword used to be UnverifiedClickTabContains, and it was renamed on 01/26/2011 due to conflict.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Partial case-sensitive text on the tab to identify which tab to click.

    TextValue is the partial case-sensitive text on the tab to identify which tab to click.

Examples:
  • T, PropertiesWin, TabControl, ClickTabContains, "StatsTab"
    A single-click is performed on the tab item whose name contains "StatsTab".

    A single-click is performed on the tab item whose name contains "StatsTab".



[How To Read This Reference]

TabControlFunctions::MakeSelection
RC RJ WR TC DRD SE2

Attempts to perform a standard Click on a particular Tab on the TabControl

Attempts to perform a standard Click on a particular Tab on the TabControl. The routine will set the StepDriverTestInfo.statuscode and log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text on the tab to identify which tab to click.

    TextValue is the case-sensitive text on the tab to identify which tab to click. *For Sheridan SSActiveTabs this will be treated as an AppMap reference to an item that contains coordinates in the form of "xcoord,ycoord". The item will be retrieved from the section in the AppMap with the Components name (Field #3).

Examples:
  • T, WINDOW, TabControl, MAKESELECTION, "StatsTab"
    A single-click is performed on the "StatsTab" tab located on the TabControl object.

    A single-click is performed on the "StatsTab" tab located on the TabControl object. For Sheridan SSActiveTabs this click location is determined by coordinates stored in the AppMap. Given the example, the AppMap will contain the following entry:

    [TabControl]
    StatsTab="100, 12"



[How To Read This Reference]

TabControlFunctions::SelectTab
RC RJ WR TC DRD SE2

Attempts to perform a standard SelectTab on a particular Tab on the TabControl

Attempts to perform a standard Selection on a particular Tab on the TabControl. The routine will set the StepDriverTestInfo.statuscode and log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.

Note, this routine will call the CLICK function to try default CLICK processing if it is not able to locate all the component properties it needs for success.

This command has been provided for times when it might work and the other TabControl CLICK alternatives do not.



Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text on the tab to identify which tab to click.

    TextValue is the case-sensitive text on the tab to identify which tab to click. If the provided text value contains ampersands (for hotkey characters) then ampersands will be retained in the TabControl text for comparisons performed to identify the correct tab to click. Otherwise, ampersands are stripped out of the TabControl text to facilitate these comparisons.

Examples:
  • T, WINDOW, TabControl, SelectTab, "StatsTab"
    A single-click is performed on the "StatsTab" tab located on the TabControl object.


[How To Read This Reference]

TabControlFunctions::SelectTabIndex
RC RJ TC DRD SE2

Attempts to select a particular Tab by Index.

Attempts to select a particular Tab by Index. The routine will set the StepDriverTestInfo.statuscode and log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.

For some engines, like Rational Robot, the user must know whether the indices of the TabControl are 0-based or 1-based and use the raw index number.

For Rational Functional Tester we attempt to enforce that all indices are 1-based whenever possible. Thus, the first tab would be specified as TabIndex=1 even if the control itself uses 0-based tab indices.



Fields: [ ]=Optional with Default Value
  1. TabIndex
    Index of the tab to click.

    The index of the tab to click. The user needs to know whether the TabControl indices are 0-based or 1-based. SAFS for RFT attempts to allow the user to use 1-based indices for all controls.

Examples:
  • T, WINDOW, TabControl, SelectTabIndex, 2
    A single-click is performed on the 2nd tab of a 1-based TabControl.

    The 2nd tab of a 1-based TabControl will likely correspond to the 3rd tab of a 0-based TabControl.

[How To Read This Reference]

TabControlFunctions::UnverifiedClick (deprecated for: UnverifiedClickTab)
WR

Use UnverifiedClickTab instead (where available).

Attempts to perform an unverified Click on a particular Tab on the TabControl. The routine will set the StepDriverTestInfo.statuscode and log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text* on the tab to identify which tab to click.

    TextValue is the case-sensitive text on the tab to identify which tab to click. *For Sheridan SSActiveTabs this will be treated as an AppMap reference to an item that contains coordinates in the form of "xcoord,ycoord". The item will be retrieved from the section in the AppMap with the Components name (Field #3).

Examples:
  • T, WINDOW, TabControl, UNVERIFIEDCLICK, "StatsTab"
    A single-click is performed on the "StatsTab" tab located on the TabControl object.

    A single-click is performed on the "StatsTab" tab located on the TabControl object. For Sheridan SSActiveTabs this click location is determined by coordinates stored in the AppMap. Given the example, the AppMap will contain the following entry:

    [TabControl]
    StatsTab="100, 12"



[How To Read This Reference]

TabControlFunctions::UnverifiedClickTab
RC RJ TC DRD SE2

Attempts to perform an unverified Click on a particular Tab on the TabControl

Attempts to perform an unverified Click on a particular Tab on the TabControl. The routine will set the StepDriverTestInfo.statuscode and log any pass/warning/fail info using the StepDriverTestInfo.fac LogFacility.

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text* on the tab to identify which tab to click.

    TextValue is the case-sensitive text on the tab to identify which tab to click. *For Sheridan SSActiveTabs this will be treated as an AppMap reference to an item that contains coordinates in the form of "xcoord,ycoord". The item will be retrieved from the section in the AppMap with the Components name (Field #3).

Examples:
  • T, WINDOW, TabControl, UnverifiedClickTab, "StatsTab"
    A single-click is performed on the "StatsTab" tab located on the TabControl object.

    A single-click is performed on the "StatsTab" tab located on the TabControl object. For Sheridan SSActiveTabs this click location is determined by coordinates stored in the AppMap. Given the example, the AppMap will contain the following entry:

    [TabControl]
    StatsTab="100, 12"



[How To Read This Reference]