This documentation is archived and is not being maintained.

Graphics.SetClip Method (GraphicsPath, CombineMode)

Sets the clipping region of this Graphics to the result of the specified operation combining the current clip region and the specified GraphicsPath.

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

public void SetClip(
	GraphicsPath path,
	CombineMode combineMode
)

Parameters

path
Type: System.Drawing.Drawing2D.GraphicsPath
GraphicsPath to combine.
combineMode
Type: System.Drawing.Drawing2D.CombineMode
Member of the CombineMode enumeration that specifies the combining operation to use.

If the graphics path represented by the path parameter is not closed, an additional segment is added from the last point to the first point to close the path.

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 graphics path and adds an ellipse to the path.

  • Sets the clipping region to the elliptical path with the Replace member.

  • Fills a large rectangle with a solid black brush.

The result is a filled, black ellipse.


private void SetClipPathCombine(PaintEventArgs e)
{

    // Create graphics path.
    GraphicsPath clipPath = new GraphicsPath();
    clipPath.AddEllipse(0, 0, 200, 100);

    // Set clipping region to path.
    e.Graphics.SetClip(clipPath, CombineMode.Replace);

    // Fill rectangle to demonstrate clipping 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: