Graphics.SetClip Method (Graphics, CombineMode)

 
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.

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

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

public void SetClip(
	Graphics g,
	CombineMode combineMode
)

Parameters

g
Type: System.Drawing.Graphics

Graphics that specifies the clip region 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 PaintEventArgse, which is a parameter of the Paint event handler, as well as thisForm, the Form for the example. The code performs the following actions:

  • Creates a temporary Graphics from the thisFormForm of the example.

  • Sets the clipping region of the temporary Graphics to a small square.

  • Updates the clipping region of the form's graphic object to that of the new Graphics with the Replace member.

  • Fills a large rectangle with a solid black brush.

The result is a small, filled, black square.

private void SetClipGraphicsCombine(PaintEventArgs e)
{

    // Create temporary graphics object and set its clipping region.
    Graphics newGraphics = this.CreateGraphics();
    newGraphics.SetClip(new Rectangle(0, 0, 100, 100));

    // Update clipping region of graphics to clipping region of new

    // graphics.
    e.Graphics.SetClip(newGraphics, CombineMode.Replace);

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

    // Release new graphics.
    newGraphics.Dispose();
}

.NET Framework
Available since 1.1
Return to top
Show: