This documentation is archived and is not being maintained.

Bitmap::Clone Method (Rectangle, PixelFormat)

Creates a copy of the section of this Bitmap defined by Rectangle structure and with a specified PixelFormat enumeration.

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

public:
Bitmap^ Clone(
	Rectangle rect, 
	PixelFormat format
)

Parameters

rect
Type: System.Drawing::Rectangle

Defines the portion of this Bitmap to copy. Coordinates are relative to this Bitmap.

format
Type: System.Drawing.Imaging::PixelFormat

Specifies the PixelFormat enumeration for the destination Bitmap.

Return Value

Type: System.Drawing::Bitmap
The new Bitmap that this method creates.

ExceptionCondition
OutOfMemoryException

rect is outside of the source bitmap bounds.

ArgumentException

The height or width of rect is 0.

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 Bitmap from a file.

  • Clones a portion of that Bitmap.

  • Draws the cloned portion to the screen.

private:
   void Clone_Example1( PaintEventArgs^ e )
   {
      // Create a Bitmap object from a file.
      Bitmap^ myBitmap = gcnew Bitmap( "Grapes.jpg" );

      // Clone a portion of the Bitmap object.
      Rectangle cloneRect = Rectangle(0,0,100,100);
      System::Drawing::Imaging::PixelFormat format = myBitmap->PixelFormat;
      Bitmap^ cloneBitmap = myBitmap->Clone( cloneRect, format );

      // Draw the cloned portion of the Bitmap object.
      e->Graphics->DrawImage( cloneBitmap, 0, 0 );
   }

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: