CaptureText/en

Description

Alias: CT

Selects and copies text.

Selects text by clicking the Button at the point specified by Reference1 related to Bitmap1 and dragging it to Reference2 related to Bitmap2. The selected text is copied using the clipboard and saved in the output parameter Text. The number of clicks in Reference1 is determined by the ClickCount parameter. It is possible to set the timeout with the Wait parameter, to skip multiple occurrences with the Skip1 and Skip2 parameters and specify masking with ( MaskMode1, BitmapMaskColor1 and ScreenMaskColor1 or MaskMode2, BitmapMaskColor2 and ScreenMaskColor2 parameters). The search area is determined by the value of the CaptureMode1 and CaptureMode2 parameters. If none of the bitmaps is found, the command ends with an error.

Input parameters

Bitmap1

Bitmap type

Bitmap for reference to the start of text selection.

Reference1

Reference type

Reference relative to Bitmap1 specifying the start of text selection.

Bitmap2

Bitmap type

Bitmap for reference to the end of text selection.

Reference2

Reference type

Reference relative to the Bitmap2 specifying the end of text selection.

ClickCount

Number type

Specifies the number of clicks at the Reference1 position. A value of 0 does not click, a value of 1 means a single click, a value of 2 means a double click, etc. The last click will be released after moving the mouse cursor at the Reference2 point.

Button

Number type

Specifies the mouse button to click (0=none, 1=left, 2=right, 3=middle).

MaskMode1

Number type

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

BitmapMaskColor1

Color type

The key color of the user mask in Bitmap1 (used only if MaskMode1=1).

ScreenMaskColor1

Color type

The key color of the user mask on the captured screen corresponding to BitmapMaskColor1. You should set this value only if these two colors are different.

MaskMode2

Number type

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

BitmapMaskColor2

Color type

The key color of the user mask in Bitmap2 (used only if MaskMode2=1).

ScreenMaskColor2

Color type

The key color of the user mask on the captured screen corresponding to BitmapMaskColor2. You should set this value only if these two colors are different.

Skip1

Number type

Defines the number of Bitmap1 occurrences that are skipped when searched.

Skip2

Number type

Defines number of Bitmap2 occurrences that are skipped when searched.

Wait

Number type

Timeout in seconds for searched bitmaps to appear.

CaptureMode1

Number type

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

CaptureMode2

Number type

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

Enabled

Number type

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

PreWait

Number type

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

PostWait

Number type

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

Output parameters

Text

String type

Text obtained from selected text using the clipboard.

See also

Examples of use

Using a mask

Capture modes

Resolving multiple occurrences of the searched bitmap

Timeout and system parameters