ComboEditBoxFunctions

Last Updated:

Actions for working with ComboEditBox objects


[How To Read This Reference]
Click
WR TC
Deprecated For:Generic CLICK
Select
RC WR TC
Select an item by its text value from a ComboEditBox.
SelectIndex
RC WR TC
Select an item by its index from a ComboEditBox (ComboBox).
SelectPartialMatch
RC WR TC
Select an item via a partial text match.
SetTextValue
RC WR TC
Set the text of the ComboEditBox
SetUnverifiedTextValue
RC TC
Set the text of the ComboEditBox without verification

ComboEditBoxFunctions::Click (deprecated for: Generic CLICK)
WR TC

Defaults to Generic CLICK where applicable.

Attempts to perform a standard Click on the ComboEditBox. If the ComboEditBox list is not exposed then this may expose the list of items. If the list is already exposed, then this may close the list. It may also just provide focus to the ComboEditBox.

It must be noted that when you expose the list in a ComboEditBox, it is no longer a ComboEditBox. It typically converts to a ComboListBox. This may not be an issue on controls that Robot can recognize with a NAME= method.

However, if the control is recognized by ObjectIndex or some other means then the original ComboEditBox may no longer be found on the screen. With this scenario, you need to reference the ComboEditBox and the ComboListBox in the application map (and associated data files) as two separate items.

To avoid these potential problems, use the ComboEditBox 'SELECT' command to actually open the list and select the item all with a single command.



Fields: [ ]=Optional with Default Value
    Examples:
    • T, WINDOW, ComboEditBox, CLICK
      Used to show or hide the drop down list or get focus for the ComboEditBox object.

      Used to show or hide the drop down list or get focus for the ComboEditBox object. Use the Select command INSTEAD of Click if you actually want to Select an item in the list.

    [How To Read This Reference]

    ComboEditBoxFunctions::Select
    RC WR TC

    Select an item by its text value from a ComboEditBox.

    Select an item by its text value from a ComboEditBox. This method combines the initial Click required to expose the list of items and then the subsequent selection of a text item from the list.

    The routine will first attempt to see if the item exists in the list and should provide a warning if it cannot find the item or cannot read the list of items. The routine will then attempt the selection.

    After the selection is attempted, the routine tries to verify that the list has the specified item as the selected item. A warning will be issued if the routine cannot read the list. A failure will be issued if the routine CAN read the list and determines that the specified item is NOT the currently selected item.



    Fields: [ ]=Optional with Default Value
    1. TextValue
      The case-sensitive item in the drop down list to select.


    Examples:
    • T, WINDOW, ComboEditBox, SELECT, "MySelection"
      This action attempts to Click AND Select "MySelection" (case-sensitive) from the ComboEditBox.


    [How To Read This Reference]

    ComboEditBoxFunctions::SelectIndex
    RC WR TC

    Select an item by its index from a ComboEditBox (ComboBox).

    Select an item by its index from a ComboEditBox (ComboBox). This method combines the initial Click required to expose the list of items and then the subsequent selection of the item from the list.

    The routine will first attempt to see if the index exists in the list and should provide a warning if it cannot find the item or cannot read the list of items. The routine will then attempt the selection.



    Fields: [ ]=Optional with Default Value
    1. IndexValue
      The item index in the drop down list to select.


    Examples:
    • T, WINDOW, ComboEditBox, SELECTINDEX, "1"
      This action attempts to Click AND Select item #1 from the ComboEditBox list.


    [How To Read This Reference]

    ComboEditBoxFunctions::SelectPartialMatch
    RC WR TC

    Select an item via a partial text match.

    Select an item via a partial text match. This method combines the initial Click required to expose the list of items and then the subsequent selection of a text item from the list.

    The routine will first attempt to see if the item exists in the list and should provide a warning if it cannot find the item or cannot read the list of items. The routine will then attempt the selection.

    After the selection is attempted, the routine tries to verify that the list has the specified item as the selected item. A warning will be issued if the routine cannot read the list. A failure will be issued if the routine CAN read the list and determines that the specified item is NOT the currently selected item.



    Fields: [ ]=Optional with Default Value
    1. TextValue
      The case-sensitive substring of an item in the drop down list to select.


    Examples:
    • T, WINDOW, ComboEditBox, SelectPartialMatch, "ATextSubstring"
      This action attempts to Click AND Select the first item containing the substring provided.


    [How To Read This Reference]

    ComboEditBoxFunctions::SetTextValue
    RC WR TC

    Set the text of the ComboEditBox

    This action sets the text of the ComboEditBox. This version allows the use of special character combinations and substrings to identify specific keyboard keys. These are the same special characters and interpretation used for Robot's InputKeys command and the Windows Scripting Host.

    ~^+%{( are primarily the characters that induce special processing.

    The routine verifies we can read the text property, sets the text value and will verify that the property has been set to that value *IF* none of the special characters exist in the provided text value. If those special characters exist, then no post-set verification will occur.



    Fields: [ ]=Optional with Default Value
    1. [ TextValue = ]
      The text that will be typed into the ComboEditBox.

      TextValue will be the text that will be typed into the ComboEditBox. Quoted text may be used to ensure proper expected value retrieval. There is also no check for a missing field because that would be the same as specifying no text ("")--which is valid.

    Examples:
    • T, WINDOW, ComboEditBox, SETTEXTVALUE, "MyPassword"
      "MyPassword" is typed into the ComboEditBox


    [How To Read This Reference]

    ComboEditBoxFunctions::SetUnverifiedTextValue
    RC TC

    Set the text of the ComboEditBox without verification

    This action sets the text of the ComboEditBox. This version allows the use of special character combinations and substrings to identify specific keyboard keys. These are the same special characters and interpretation used for Robot's InputKeys command and the Windows Scripting Host.

    ~^+%{( are primarily the characters that induce special processing.

    The routine verifies we can read the text property, sets the text value but does not verify that the property has been set to that value and does not verify whether or not any of the special characters exist in the provided text value.



    Fields: [ ]=Optional with Default Value
    1. [ TextValue = ]
      The text that will be typed into the ComboEditBox.

      TextValue will be the text that will be typed into the ComboEditBox. Quoted text may be used to ensure proper expected value retrieval. There is also no check for a missing field because that would be the same as specifying no text ("")--which is valid.

    Examples:
    • T, WINDOW, ComboEditBox, SETUNVERIFIEDTEXTVALUE, "MyPassword"
      "MyPassword" is typed into the ComboEditBox, but not verified


    [How To Read This Reference]