This documentation is archived and is not being maintained.

Graphics.SetClip Method (Rectangle, CombineMode)

Sets the clipping region of this Graphics to the result of the specified operation combining the current clip region and the rectangle specified by a Rectangle structure.

Namespace:  System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

public void SetClip(
	Rectangle rect,
	CombineMode combineMode
)

Parameters

rect
Type: System.Drawing.Rectangle
Rectangle structure to combine.
combineMode
Type: System.Drawing.Drawing2D.CombineMode
Member of the CombineMode enumeration that specifies the combining operation to use.

The following code example is designed for use with Windows Forms, and it requires PaintEventArgs e, which is a parameter of the Paint event handler. The code performs the following actions:

  • Creates a small rectangle for the clipping region.

  • Sets the clipping region to the rectangle with the Replace member.

  • Fills a large rectangle with a solid black brush.

The result is a small, filled, black rectangle.


private void SetClipRectangleCombine(PaintEventArgs e)
{

    // Create rectangle for clipping region.
    Rectangle clipRect = new Rectangle(0, 0, 100, 100);

    // Set clipping region of graphics to rectangle.
    e.Graphics.SetClip(clipRect, CombineMode.Replace);

    // Fill rectangle to demonstrate clip region.
    e.Graphics.FillRectangle(new SolidBrush(Color.Black), 0, 0, 500, 300);
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.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.
Show: