VisualStyleRenderer.GetBackgroundExtent Method (IDeviceContext, Rectangle)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the entire background area for the current visual style element.

Namespace:   System.Windows.Forms.VisualStyles
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public Rectangle GetBackgroundExtent(
	IDeviceContext dc,
	Rectangle contentBounds
)

Parameters

dc
Type: System.Drawing.IDeviceContext

The IDeviceContext this operation will use.

contentBounds
Type: System.Drawing.Rectangle

A Rectangle that contains the content area of the current visual style element.

Return Value

Type: System.Drawing.Rectangle

A Rectangle that contains the entire background area of the current visual style element.

Exception Condition
ArgumentNullException

dc is null.

A visual style can define a content area within each background image. This is the area in which content such as text and icons can be placed without overwriting background borders. This method uses the given content area to calculate the entire background area for the current visual style element.

.NET Framework
Available since 2.0
Return to top
Show: