Graphics.SetClip Method

Definition

Namespace:

System.Drawing

Assembly:

System.Drawing.Common.dll

Sets the clipping region of this Graphics to the Clip property of the specified Graphics.

Overloads

SetClip(Region, CombineMode)	Sets the clipping region of this Graphics to the result of the specified operation combining the current clip region and the specified Region.
SetClip(RectangleF, 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 RectangleF structure.
SetClip(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.
SetClip(Graphics, CombineMode)	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.
SetClip(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.
SetClip(RectangleF)	Sets the clipping region of this Graphics to the rectangle specified by a RectangleF structure.
SetClip(Rectangle)	Sets the clipping region of this Graphics to the rectangle specified by a Rectangle structure.
SetClip(Graphics)	Sets the clipping region of this Graphics to the Clip property of the specified Graphics.
SetClip(GraphicsPath)	Sets the clipping region of this Graphics to the specified GraphicsPath.

SetClip(Region, CombineMode)

Source:

Graphics.cs

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

C#

public void SetClip(System.Drawing.Region region, System.Drawing.Drawing2D.CombineMode combineMode);

Parameters

region

Region

Region to combine.

combineMode

CombineMode

Member from the CombineMode enumeration that specifies the combining operation to use.

Examples

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.

C#

private void SetClipRegionCombine(PaintEventArgs e)
{

    // Create region for clipping.
    Region clipRegion = new Region(new Rectangle(0, 0, 100, 100));

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

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

SetClip(RectangleF, CombineMode)

Source:

Graphics.cs

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 RectangleF structure.

C#

public void SetClip(System.Drawing.RectangleF rect, System.Drawing.Drawing2D.CombineMode combineMode);

Parameters

rect

RectangleF

RectangleF structure to combine.

combineMode

CombineMode

Member of the CombineMode enumeration that specifies the combining operation to use.

Examples

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.

C#

private void SetClipRectangleFCombine(PaintEventArgs e)
{

    // Create rectangle for clipping region.
    RectangleF clipRect = new RectangleF(0.0F, 0.0F, 100.0F, 100.0F);

    // 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);
}

SetClip(Rectangle, CombineMode)

Source:

Graphics.cs

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.

C#

public void SetClip(System.Drawing.Rectangle rect, System.Drawing.Drawing2D.CombineMode combineMode);

Parameters

rect

Rectangle

Rectangle structure to combine.

combineMode

CombineMode

Member of the CombineMode enumeration that specifies the combining operation to use.

Examples

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.

C#

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);
}

SetClip(Graphics, CombineMode)

Source:

Graphics.cs

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.

C#

public void SetClip(System.Drawing.Graphics g, System.Drawing.Drawing2D.CombineMode combineMode);

Parameters

g

Graphics

Graphics that specifies the clip region to combine.

combineMode

CombineMode

Member of the CombineMode enumeration that specifies the combining operation to use.

Examples

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, as well as thisForm, the Form for the example. The code performs the following actions:

• Creates a temporary Graphics from the thisForm Form 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.

C#

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();
}

SetClip(GraphicsPath, CombineMode)

Source:

Graphics.cs

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

C#

public void SetClip(System.Drawing.Drawing2D.GraphicsPath path, System.Drawing.Drawing2D.CombineMode combineMode);

Parameters

path

GraphicsPath

GraphicsPath to combine.

combineMode

CombineMode

Member of the CombineMode enumeration that specifies the combining operation to use.

Examples

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.

C#

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);
}

Remarks

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.

SetClip(RectangleF)

Source:

Graphics.cs

Sets the clipping region of this Graphics to the rectangle specified by a RectangleF structure.

C#

public void SetClip(System.Drawing.RectangleF rect);

Parameters

rect

RectangleF

RectangleF structure that represents the new clip region.

Examples

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.

• Fills a large rectangle with a solid black brush.

The result is a small, filled, black rectangle.

C#

private void SetClipRectangleF(PaintEventArgs e)
{

    // Create rectangle for clipping region.
    RectangleF clipRect = new RectangleF(0.0F, 0.0F, 100.0F, 100.0F);

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

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

SetClip(Rectangle)

Source:

Graphics.cs

Sets the clipping region of this Graphics to the rectangle specified by a Rectangle structure.

C#

public void SetClip(System.Drawing.Rectangle rect);

Parameters

rect

Rectangle

Rectangle structure that represents the new clip region.

Examples

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.

• Fills a large rectangle with a solid black brush.

The result is a small, filled, black rectangle.

C#

private void SetClipRectangle(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);

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

SetClip(Graphics)

Source:

Graphics.cs

Sets the clipping region of this Graphics to the Clip property of the specified Graphics.

C#

public void SetClip(System.Drawing.Graphics g);

Parameters

g

Graphics

Graphics from which to take the new clip region.

Examples

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, as well as thisForm, the Form for the example. The code performs the following actions:

• Creates a temporary Graphics from the thisForm Form 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 temporary Graphics.

• Fills a large rectangle with a solid black brush.

The result is a small, filled, black square.

C#

private void SetClipGraphics(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);

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

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

SetClip(GraphicsPath)

Source:

Graphics.cs

Sets the clipping region of this Graphics to the specified GraphicsPath.

C#

public void SetClip(System.Drawing.Drawing2D.GraphicsPath path);

Parameters

path

GraphicsPath

GraphicsPath that represents the new clip region.

Examples

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.

• Fills a large rectangle with a solid black brush.

The result is a filled, black ellipse.

C#

private void SetClipPath(PaintEventArgs e)
{

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

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

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

Remarks

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.