ToolBarFunctions

Last Updated:

Actions for working with ToolBar objects.

Toolbars come in many different flavors. The toolbar support defined here is not going to work for all toolbars in all different environments. The tester will have to experiment using these commands against their specific toolbar.

[How To Read This Reference]
ClickButton
RC TC
Deprecated For:ClickButtonText
ClickButtonIndex
RJ TC
Click on the icon at a certain position on the ToolBar object, it is 1-based.
ClickButtonText
RC RJ TC
Routine to Click on the specified Button.Key (Text) value.
ClickButtonTooltip
RJ
Click on the icon whose tooltip equals to the provided parameter
ClickUnverifiedButtonID
RC
Routine to select a toolbar button using it's ID.
ClickUnverifiedButtonText
RC RJ TC
Routine to Click on the specified Button.Key (Text) value.
VerifyButtonClicked
RC
Verifies a particular case-sensitive button text item is selected
VerifyButtonCount
RC
Verifies a total button presents in the Toolbar.
VerifyButtonText
RC
Verifies a particular case-sensitive text (button.key) item exists
VerifyButtonUnClicked
RC
Verifies a particular case-sensitive button text item is unselected

ToolBarFunctions::ClickButton (deprecated for: ClickButtonText)
RC TC

Deprecated. Use ClickButtonText instead.

Deprecated. Use ClickButtonText instead.

Fields: [ ]=Optional with Default Value
  1. ButtonTextValue
    Case-sensitive text of the toolbar button to select.

    Case-sensitive text of the toolbar button to select.

  2. [ CaseInsensitive = ]
    "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.


Examples:
[How To Read This Reference]

ToolBarFunctions::ClickButtonIndex
RJ TC

Click on the icon at a certain position on the ToolBar object, it is 1-based.

Click on the icon at a certain position on the ToolBar object, it is 1-based.

Fields: [ ]=Optional with Default Value
  1. Index
    Index described which icon to be clicked in the toolbar.

    Index described which icon to be clicked in the toolbar.
    RJ Note:
    1. If the index is bigger than the number of children of toolbar, the last icon will be clicked.
    2. The tool bar separator is not counted for indexing. If the toolbar contains "button1 | button2", button1 is at index 1, button2 is at index 2, the separator between these two buttons is not counted.


  2. [ Coordination = ]
    A position within the toolbar button, the mouse will be click there.
    RJ Note: This parameter is special for RJ implementation.


Examples:
[How To Read This Reference]

ToolBarFunctions::ClickButtonText
RC RJ TC

Routine to Click on the specified Button.Key (Text) value.

Routine to Click on the specified Button.Key (Text) value. The user has an optional parameter to specify that the provided text is case-insensitive. The routine will also verify that the button is in the clicked or selected state upon completion.
Use ClickUnverifiedButtonText if this post-click verification should be skipped.


Fields: [ ]=Optional with Default Value
  1. ButtonTextValue
    Case-sensitive text of the toolbar button to select.

    Case-sensitive text of the toolbar button to select.
    RJ Note: This parameter may be a path like "a->b->c"


  2. [ CaseInsensitive = ]
    "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.


  3. [ Coordination = ]
    A position within the toolbar button, the mouse will be click there.
    RJ Note: This parameter is special for RJ implementation.


Examples:
[How To Read This Reference]

ToolBarFunctions::ClickButtonTooltip
RJ

Click on the icon whose tooltip equals to the provided parameter

Click on the icon whose tooltip equals to the provided parameter

Fields: [ ]=Optional with Default Value
  1. Tooltip
    Tooltip is description of the icon on ToolBar.

    Tooltip is description of the icon on ToolBar.

Examples:
[How To Read This Reference]

ToolBarFunctions::ClickUnverifiedButtonID
RC

Routine to select a toolbar button using it's ID.

Routine to select a toolbar button using it's ID.

Fields: [ ]=Optional with Default Value
  1. ButtonID
    ID for a particular button in the toolbar to select.

    ID for a particular button in the toolbar to select.

Examples:
[How To Read This Reference]

ToolBarFunctions::ClickUnverifiedButtonText
RC RJ TC

Routine to Click on the specified Button.Key (Text) value.

Routine to Click on the specified Button.Key (Text) value. The user has an optional parameter to specify that the provided text is case-insensitive. However, not all Toolbars and Buttons will be able to support this case-insensitive capability.

Fields: [ ]=Optional with Default Value
  1. ButtonTextValue
    Case-sensitive text of the toolbar button to select.

    Case-sensitive text of the toolbar button to select.
    RJ Note: This parameter may be a path like "a->b->c"


  2. [ CaseInsensitive = ]
    "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.

    Not all toolbars and buttons will be able to support this case-insensitive option.

  3. [ Coordination = ]
    A position within the toolbar button, the mouse will be click there. RJ Note: This parameter is special for RJ implementation.


Examples:
[How To Read This Reference]

ToolBarFunctions::VerifyButtonClicked
RC

Verifies a particular case-sensitive button text item is selected

Verifies a particular case-sensitive button text item is selected

Fields: [ ]=Optional with Default Value
  1. ButtonTextValue
    Case-sensitive text(Button.Key) of button that will be verified as clicked

    TextValue should contain the case-sensitive text(Button.Key) of the item expected to already be clicked

Examples:
[How To Read This Reference]

ToolBarFunctions::VerifyButtonCount
RC

Verifies a total button presents in the Toolbar.

Verifies a total button presents in the Toolbar. Count includes buttons which are not visible as well.

Fields: [ ]=Optional with Default Value
  1. ButtonCount
    Numeric count value represents the total button counts in the Toolbar.

    Numeric count value represents the total button counts in the Toolbar.

Examples:
[How To Read This Reference]

ToolBarFunctions::VerifyButtonText
RC

Verifies a particular case-sensitive text (button.key) item exists

Verifies a particular case-sensitive text (button.key) item exists

Fields: [ ]=Optional with Default Value
  1. ButtonTextValue
    Case-sensitive text (button.key) item that will be verified as exists

    TextValue should contain the case-sensitive text of the item expected to exist. The user has an optional parameter to specify that the provided text is case-insensitive.

  2. [ CaseInsensitive = ]
    "1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.


Examples:
[How To Read This Reference]

ToolBarFunctions::VerifyButtonUnClicked
RC

Verifies a particular case-sensitive button text item is unselected

Verifies a particular case-sensitive button text item is unselected

Fields: [ ]=Optional with Default Value
  1. ButtonTextValue
    Case-sensitive text(Button.Key) of button that will be verified as unselected

    TextValue should contain the case-sensitive text(Button.Key) of the item expected to be unselected

Examples:
[How To Read This Reference]