This topic has not yet been rated - Rate this topic

VisualStyleRenderer.HitTestBackground Method (IDeviceContext, Rectangle, IntPtr, Point, HitTestOptions)

Returns a hit test code indicating whether the point is contained in the background of the current visual style element and within the specified region.

Namespace:  System.Windows.Forms.VisualStyles
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public HitTestCode HitTestBackground(
	IDeviceContext dc,
	Rectangle backgroundRectangle,
	IntPtr hRgn,
	Point pt,
	HitTestOptions options
)

Parameters

dc
Type: System.Drawing.IDeviceContext
The IDeviceContext this operation will use.
backgroundRectangle
Type: System.Drawing.Rectangle
A Rectangle that contains the background of the current visual style element.
hRgn
Type: System.IntPtr
A Windows handle to a Region that specifies the bounds of the hit test area within the background.
pt
Type: System.Drawing.Point
The Point to test.
options
Type: System.Windows.Forms.VisualStyles.HitTestOptions
A bitwise combination of the HitTestOptions values.

Return Value

Type: System.Windows.Forms.VisualStyles.HitTestCode
A HitTestCode that describes where pt is located in the background of the current visual style element.
Exception Condition
ArgumentNullException

dc is null.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ