SetField/en

Description

Alias: SF

Filling in the text field.

Searches for the bitmap screen provided by the Bitmap parameter, and simulates at the Reference point relative to it a left mouse button click in order to activate the text field expected at that point. It then clears the original content in the mode specified by ClearMode and types in the text saved in the Text parameter. The typing simulation mode is provided by TypeMode. Finally, the keystroke specified by AppendKey can be simulated or, if AppendLabelClick is non-null, then the click on the bitmap found. To search for reference bitmaps, timeout can be set with Wait, skipping multiple occurrences using Skip, and doing a masked search using MaskMode, BitmapMaskColor and ScreenMaskColor. The search area is specified by the value of the CaptureMode. If the specified bitmap is not found, the command ends in error.

Input parameters

Bitmap

Type Bitmap

Related bitmap that together with the Reference specifies the position of the text field.

Reference

Type Reference

Reference to the text field relative to the Bitmap.

Text

Type String

Text for completing the field

MaskMode

Type Number

Mask mode used for the search (0=none, 1=user mask, 2=automatic mask).

BitmapMaskColor

Type Color

Key color of the user mask in the specified bitmap (used only for MaskMode=1).

ScreenMaskColor

Type Color

Key color of the user mask for the capture, matching the color of the BitmapMaskColor. You should set this value only if these two colors are different.

Skip

Type Number

Determines the number of occurrences of bitmaps skipped during the search.

Wait

Type Number

Waiting time in seconds for the searched bitmap to appear.

CaptureMode

Type Number

Defines the search area (0=desktop, 1=active window, 2=active region, 3=active window area, 16=client part of the active window, 257-264=monitor 1-8, 512-520=active region 0-8).

ClearMode

Type Number

Mode for clearing the content of the field (0=Leave content, 1=Ctrl+A/Del, 2=Home/Shift+End/Del, 3=Ctrl+A/Back, 4=Home/Shift+End/Back)

TypeMode

Type Number

Typing text mode (0=send message, 1=keyboard event (Alt+0xxx), 2=keyboard event (local keyboard), 3=send message (no delay))

AppendKey

Type String

For a non-null value, it simulates the specified keystroke after filling in the field

AppendLabelClick

Type Number

For a non-null value, it clicks on the found Bitmap after filling in the field.

OnlyIfNotNull

Type Number

If the value is 1, the command will not execute unless the Bitmap or Text is specified.

Enabled

Type Number

Enables or disables the command. If the value is 0, the command will not execute.

PreWait

Type Number

Delay in milliseconds before executing the command. It has no effect if Enabled=0.

PostWait

Type Number

Delay in milliseconds before executing the command. It has no effect if Enabled=0.

See also

Examples of use

Using masks

Capture modes

Resolving multiple occurrences of the searched bitmap

Timeout and system parameters