Graphics.ExcludeClip Method (Region)

 
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.

Updates the clip region of this Graphics to exclude the area specified by a Region.

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

public void ExcludeClip(
	Region region
)

Parameters

region
Type: System.Drawing.Region

Region that specifies the region to exclude from the clip region.

This method excludes the area specified by the region parameter from the current clip region and assigns the resulting area to the Clip property of this Graphics.

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

  • Creates a 100 pixel by 100 pixel rectangle whose upper-left corner is at the coordinate (100, 100).

  • Sets the clipping region to exclude the rectangle.

  • Fills a 300 pixel by 300 pixel rectangle whose upper-left corner is at the coordinate (0, 0) with a solid blue brush.

The result is a blue rectangle with a square area toward its lower-right corner missing.

public void ExcludeClipRegion(PaintEventArgs e)
{

    // Create rectangle for region.
    Rectangle excludeRect = new Rectangle(100, 100, 200, 200);

    // Create region for exclusion.
    Region excludeRegion = new Region(excludeRect);

    // Set clipping region to exclude region.
    e.Graphics.ExcludeClip(excludeRegion);

    // Fill large rectangle to show clipping region.
    e.Graphics.FillRectangle(new SolidBrush(Color.Blue), 0, 0, 300, 300);
}

.NET Framework
Available since 1.1
Return to top
Show: