CaptureDesktopImageWithSurroundingArea Method (element, mousePoint, highlightColor)

Captures an image of the of the element and its surrounding area from the desktop.

Declaration Syntax

Visual Basic

Visual C++

public static Bitmap CaptureDesktopImageWithSurroundingArea(
	Element element,
	Nullable<Point> mousePoint,
	Color highlightColor
)

Public Shared Function CaptureDesktopImageWithSurroundingArea ( _
	element As Element, _
	mousePoint As Nullable(Of Point), _
	highlightColor As Color _
) As Bitmap

public:
static Bitmap^ CaptureDesktopImageWithSurroundingArea(
	Element^ element, 
	Nullable<Point> mousePoint, 
	Color highlightColor
)

Parameters

element (Element): The element to capture within its periphery.

mousePoint (Nullable<(Of <(Point>)>)): A point specifying the screen coordinates of the current mouse cursor or null in order not to capture the mouse cursor.

highlightColor (Color): The color used to highlight the element within its surrounding area or Empty to not highlight the element.

Return Value

The captured image.

Exceptions

Exception	Condition
ArgumentNullException	element is a null reference.

Assembly: Ranorex.Core (Module: Ranorex.Core) Version: 3.2.3.16825 (3.2.3.16825)