Help files

Data Types

Every piece of information that you store in your variables, has a specific type. There are 17 main data types that WinAutomation recognizes:

Text

A “Text” variable can contain any kind of text, from your e-mail address to the text contents of a .txt file. For example, input through the “Display Input Dialog” Action will always be stored as text (even if a number is entered). To convert text into a number you will have to use the “Convert Text to Number” Action.

Number

A variable of this data type can contain any numerical value. Numbers can only be used in mathematical operations if they are of this data type.

Boolean

The value of this data type can be either “True” or “False”. For example, the attributes of a file (such as "Hidden") are of type Boolean. If a file is stored in a variable called %MyFile%, %MyFile.IsHidden% will be hold the value “True” if the file is hidden and “False” if it is not. (Is Hidden is a property of the “File” data type; for more information about data type properties, see “Data Type Properties”).

Custom Dialog Instance

A variable of this type is created through the “Display Custom Dialog” Action. It is used to uniquely identify a specific custom dialog created by the corresponding Action. Every Custom Dialog Instance has properties (e.g. LastButtonPressed). For more information about data type properties see “Data Type Properties”. Variables of the "Custom Dialog Instance" data type can be used in place of a UI Automation "Window Instance" in UI and Windows-related Actions.

Custom Object

Custom Objects are a type of Variable inWinAutomationthat allows users to generate and/or translate ("Convert Custom Object To JSON") data into JSON format. Custom Objects are essentially Property Names with their corresponding values. These values can be accessed using dot (.) notation or bracket ([]) notation since any two different Properties of a Custom Object may have the same value but not the same name.

List

A list contains multiple values. Depending on the types of the individual list items, there can be lists of text values, lists of numbers, lists of files, etc. The list data type is the equivalent of a single-dimension array in programming terms. For more information about lists, see “Lists”.

DataRow

A DataRow contains multiple values in a single, iterable row.

DataTable

A DataTable contains data in a tabular form. The DataTable is iterable, and each row is of DataRow type. It is the equivalent of a two-dimensional array in programming terms. For more information about data tables, see “Data Tables”.

Date Time

Contains basic date and time information. The date and time format(s) of a “date time” variable depends on the machine’s regional settings. To retrieve a special textual representation of a Date Time value you need to convert the value into text with the "Convert DateTime to Text" Action.

Excel Instance

A variable of this type can be created through the “Launch Excel” Action. It is used to uniquely identify the specific instance of a running Excel. Every other Action under “Excel” category (e.g. “Read from Excel”) will require that you specify an existing Excel instance. Variables of the "Excel Instance" type can be used in place of a UI Automation Window Instance in UI and Windows-related Actions.

FTP Connection

A variable of this type can be created through the “Open FTP Connection” and “Open Secure FTP Connection” Actions. It is used to uniquely identify the FTP connection that was opened. Every other Action under “FTP” category (e.g. “Download File(s) from FTP”) will require that you specify an existing FTP connection (i.e. the specific FTP site where the file(s) will be downloaded from).

File

Represents a file. Files can be used as input in any of the Actions under “Files” category. Every file has properties (e.g. Size). You can retrieve a file’s properties by using the following notation: %VariableName.PropertyName%. For more information about data type properties see “Data Type Properties”.

Folder

Represents a folder. Folders can be used as input in any of the Actions under “Folders” category. Every folder has properties (e.g. CreationTime). You can retrieve a folder’s properties by using the following notation: %VariableName.PropertyName%. For more information about data type properties see “Data Type Properties”.

Browser Instance

A value of this type can be created through the “Launch New Internet Explorer” and other Browser Launching Actions. It is used to uniquely identify the specific instance of a Web Browser that was launched or attached to. Every other Action under “Web Automation” category (e.g. “Click Link on Web Page”) will require that you specify an existing Web Browser instance (i.e. the specific browser window that contains a link to be clicked). Values of the "Web Browser Instance" type can be used in place of a UI Automation "Window Instance" in UI and Windows Actions.

Mail Message

Represents an e-mail message. These variables are populated by the "Retrieve Emails" Action. Every e-mail message has certain properties (e.g. Subject). You can retrieve an email’s properties by using the following notation: %VariableName.PropertyName%. For more information about data type properties see “Data Type Properties”.

OCR Engine

A variable of this type can be created through the "Create OCR Engine" group of Actions. It will hold the OCR's engine's instance created in a variable, to be used in any further OCR-related Actions that require the initialization of an OCR engine to work. Such Actions are: "Extract Text With OCR", "Extract text From PDF With OCR" and "If Text on Screen (OCR)".

Window Instance

A variable of this type can be created through the “Get Window” Action. It is used to uniquely identify an application Window on the user's desktop. UI and Windows-related Actions will require that you specify a target Window instance (i.e. the specific Window which will be acted upon, or which contains the target element(s)).