get text background color


Retrieve color code of the text background, in hexadecimal.


TA name of the window.
(Optional) TA name of the control.
drawing function
(Optional) TestArchitect detects the text fragment drawn by several drawing functions.
Allowable values:
  • DrawTextA: Retrieve texts drawn by the DrawTextA function (ANSI name).
  • DrawTextW: Retrieve texts drawn by the DrawTextW function (Unicode name).
  • TextOutA: Retrieve texts drawn by the TextOutA function (ANSI name).
  • TextOutW: Retrieve texts drawn by the TextOutA function (Unicode name).
  • ExtTextOutA: Retrieve texts drawn by the ExtTextOutA function (ANSI name).
  • ExtTextOutW: Retrieve texts drawn by the ExtTextOutW function (Unicode name).
  • If the argument's value is omitted, by default, TestArchitect retrieve texts drawn by all drawing functions above.
  • To use multiple values at a time, use semi-colon ( ; ) as delimiters between values.
String representing the bitmap text fragment to be searched for.
(Optional) Specifies a minimum number of instances of the search text that must be discovered within the active area for the target bitmap text fragment to be considered as found (default = 1).
(Optional) Variable to receive the returned value.

Valid contexts

This action may be used within the following project items: test modules and user-defined actions.

Applicable Systems/Platforms

Use of this action is supported on the following systems/platforms:
  • Windows: Win32, WinForms.

Applicable Built-In Settings

The following settings are applicable to this action: case sensitive, remove double quotes from cells, standard ASCII only, object wait, window wait.


  • This built-in action always employs the Graphics Device Interface (GDI) technique. In other words, Optical Character Recognition (OCR) technique is not available for this action.
  • text argument:
    • While the case sensitive built-in setting applies to the property values used to identify the correct window or control for this action, the action's GDI text identification functionality is also case sensitive, and is affected by the value of this setting.
    • It is highly recommended that you apply wildcards for this argument's value, since the text re-drawn by given drawing functions might contain surrounding noise. For example: given a value of {Administration.*}, TestArchitect searches for texts whose string beginnings match Administration. In more general terms, this argument accepts regular expressions.
  • drawing function argument:
    • By default, when the argument's value is omitted, this built-in action automatically employs all available drawing functions. This might significantly cause a performance issue, since every drawing function will be in turn verified.
    • To determine which exact drawing functions should be employed to enhance automation performance, use the Text Recognition feature available in the Interface Viewer. (Learn more.)
  • variable argument:
    • If the variable in argument variable has not been declared, the action creates it as a global.
    • If the variable argument is left empty, TestArchitect supplies a global variable with the name _result.
  • This action supports the <ignore> modifier. If the string <ignore> is present as the value of any of the arguments, or any argument contains an expression that evaluates to <ignore>, the action is skipped during execution.


Action Lines