Graphics.ExcludeClip Method

Definition

Namespace:

System.Drawing

Assembly:

System.Drawing.Common.dll

Package:

System.Drawing.Common v9.0.0-rc.2.24474.1

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

Overloads

ExcludeClip(Region)	Updates the clip region of this Graphics to exclude the area specified by a Region.
ExcludeClip(Rectangle)	Updates the clip region of this Graphics to exclude the area specified by a Rectangle structure.

ExcludeClip(Region)

Source:

Graphics.cs

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

public:
 void ExcludeClip(System::Drawing::Region ^ region);

public void ExcludeClip (System.Drawing.Region region);

member this.ExcludeClip : System.Drawing.Region -> unit

Public Sub ExcludeClip (region As Region)

Parameters

region

Region

Region that specifies the region to exclude from the 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 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 = Rectangle(100,100,200,200);

      // Create region for exclusion.
      System::Drawing::Region^ excludeRegion = gcnew System::Drawing::Region( excludeRect );

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

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

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

Public Sub ExcludeClipRegion(ByVal e As PaintEventArgs)

    ' Create rectangle for region.
    Dim excludeRect As New Rectangle(100, 100, 200, 200)

    ' Create region for exclusion.
    Dim excludeRegion As 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)
End Sub

Remarks

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.

ExcludeClip(Rectangle)

Source:

Graphics.cs

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

public:
 void ExcludeClip(System::Drawing::Rectangle rect);

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

member this.ExcludeClip : System.Drawing.Rectangle -> unit

Public Sub ExcludeClip (rect As Rectangle)

Parameters

rect

Rectangle

Rectangle structure that specifies the rectangle to exclude from the 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 100 pixel by 100 pixel rectangle whose upper-left corner is at the coordinate (100, 100).

• Creates a region defined by the rectangle.

• Sets the clipping region to exclude the rectangular region.

• 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 region toward its lower-right corner missing.

public:
   void ExcludeClipRectangle( PaintEventArgs^ e )
   {
      // Create rectangle for exclusion.
      Rectangle excludeRect = Rectangle(100,100,200,200);

      // Set clipping region to exclude rectangle.
      e->Graphics->ExcludeClip( excludeRect );

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

public void ExcludeClipRectangle(PaintEventArgs e)
{
             
    // Create rectangle for exclusion.
    Rectangle excludeRect = new Rectangle(100, 100, 200, 200);
             
    // Set clipping region to exclude rectangle.
    e.Graphics.ExcludeClip(excludeRect);
             
    // Fill large rectangle to show clipping region.
    e.Graphics.FillRectangle(new SolidBrush(Color.Blue), 0, 0, 300, 300);
}

Public Sub ExcludeClipRectangle(ByVal e As PaintEventArgs)

    ' Create rectangle for exclusion.
    Dim excludeRect As New Rectangle(100, 100, 200, 200)

    ' Set clipping region to exclude rectangle.
    e.Graphics.ExcludeClip(excludeRect)

    ' Fill large rectangle to show clipping region.
    e.Graphics.FillRectangle(New SolidBrush(Color.Blue), 0, 0, _
    300, 300)
End Sub

Remarks

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