VisualStyleRenderer.GetBackgroundExtent(IDeviceContext, Rectangle) Method

Reference

Definition

Namespace:: System.Windows.Forms.VisualStyles

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 System::Drawing::Rectangle GetBackgroundExtent(System::Drawing::IDeviceContext ^ dc, System::Drawing::Rectangle contentBounds);

public System.Drawing.Rectangle GetBackgroundExtent (System.Drawing.IDeviceContext dc, System.Drawing.Rectangle contentBounds);

member this.GetBackgroundExtent : System.Drawing.IDeviceContext * System.Drawing.Rectangle -> System.Drawing.Rectangle

Public Function GetBackgroundExtent (dc As IDeviceContext, contentBounds As Rectangle) As Rectangle

Parameters

dc: IDeviceContext

The IDeviceContext this operation will use.

contentBounds: Rectangle

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

Returns

Rectangle

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

Exceptions

ArgumentNullException

dc is null.

Remarks

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.

Applies to