APIScreenshotOffsetFromImage Method |
Take a screenshot of a region offset from the top left X/Y coordinate of the matching image on the screen.
Namespace:
AppRobotic
Assembly:
AppRobotic (in AppRobotic.dll) Version: 15.21.3.21 (15.21.03.21)
Syntax public string ScreenshotOffsetFromImage(
string ImageToFindPath,
string FilePathToSaveScreenshotAsPng,
double MatchPercent,
string ColorOrGrayScaleMode,
int ImageFoundOrder,
int OffsetX,
int OffsetY,
int ScreenshotWidth,
int ScreenshotHeight
)
Parameters
- ImageToFindPath
- Type: SystemString
File path to the image you would like to find on the screen. - FilePathToSaveScreenshotAsPng
- Type: SystemString
File path to save screenshot. - MatchPercent
- Type: SystemDouble
Similarity threshold to apply during the search, specify: 0 to 100. - ColorOrGrayScaleMode
- Type: SystemString
Match mode to use during search, specify: Color or GrayScale. - ImageFoundOrder
- Type: SystemInt32
Specify the Found Order of the Image on which you would like to perform an Action. For example, if there are 3 matching images found on the screen with the Vision tool, and you would like to click only the 2nd image found, specify the order in which it is found, such as 2nd of 3 images found, i.e. 2 (integer, without quotes) - OffsetX
- Type: SystemInt32
Offset from found matching image top-left X coordinate to begin screenshot. - OffsetY
- Type: SystemInt32
Offset from found matching image top-left Y coordinate to begin screenshot. - ScreenshotWidth
- Type: SystemInt32
Integer width of screenshot in pixels. - ScreenshotHeight
- Type: SystemInt32
Integer height of screenshot in pixels.
Return Value
Type:
StringReturns string containing 'success' or error message.
See Also