Graphics.DrawImage Method (Image, Rectangle, Single, Single, Single, Single, GraphicsUnit)

 
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.

Draws the specified portion of the specified Image at the specified location and with the specified size.

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

Public Sub DrawImage (
	image As Image,
	destRect As Rectangle,
	srcX As Single,
	srcY As Single,
	srcWidth As Single,
	srcHeight As Single,
	srcUnit As GraphicsUnit
)

Parameters

image
Type: System.Drawing.Image

Image to draw.

destRect
Type: System.Drawing.Rectangle

Rectangle structure that specifies the location and size of the drawn image. The image is scaled to fit the rectangle.

srcX
Type: System.Single

The x-coordinate of the upper-left corner of the portion of the source image to draw.

srcY
Type: System.Single

The y-coordinate of the upper-left corner of the portion of the source image to draw.

srcWidth
Type: System.Single

Width of the portion of the source image to draw.

srcHeight
Type: System.Single

Height of the portion of the source image to draw.

srcUnit
Type: System.Drawing.GraphicsUnit

Member of the GraphicsUnit enumeration that specifies the units of measure used to determine the source rectangle.

Exception Condition
ArgumentNullException

image is null.

The srcX, srcY, srcWidth, and srcHeight parameters specify a rectangular portion, of the image object to draw. The rectangle is relative to the upper-left corner of the source image. This portion is scaled to fit inside the rectangle specified by the destRect parameter.

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 an image from a JPEG file SampImag.jpg in the folder of the example.

  • Creates the coordinates of a destination rectangle in which to draw the image.

  • Creates a source rectangle from which to extract a portion of the image.

  • Sets the unit of measure of the source rectangle to pixels.

  • Draws the image to the screen.

The position of the destination rectangle locates the image on the screen, the sizes of the source and destination rectangles determine the scaling of the drawn image, and the size of the source rectangle determines what portion of the original image is drawn to the screen.

Private Sub DrawImageRect4Float(ByVal e As PaintEventArgs)

    ' Create image.
    Dim newImage As Image = Image.FromFile("SampImag.jpg")

    ' Create rectangle for displaying image.
    Dim destRect As New Rectangle(100, 100, 450, 150)

    ' Create coordinates of rectangle for source image.
    Dim x As Single = 50.0F
    Dim y As Single = 50.0F
    Dim width As Single = 150.0F
    Dim height As Single = 150.0F
    Dim units As GraphicsUnit = GraphicsUnit.Pixel

    ' Draw image to screen.
    e.Graphics.DrawImage(newImage, destRect, x, y, width, height, _
    units)
End Sub

.NET Framework
Available since 1.1
Return to top
Show: