Graphics.DrawImage Method (Image, Rectangle, Int32, Int32, Int32, Int32, GraphicsUnit, ImageAttributes, Graphics.DrawImageAbort)


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 Integer,
	srcY As Integer,
	srcWidth As Integer,
	srcHeight As Integer,
	srcUnit As GraphicsUnit,
	imageAttr As ImageAttributes,
	callback As Graphics.DrawImageAbort


Type: System.Drawing.Image

Image to draw.

Type: System.Drawing.Rectangle

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

Type: System.Int32

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

Type: System.Int32

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

Type: System.Int32

Width of the portion of the source image to draw.

Type: System.Int32

Height of the portion of the source image to draw.

Type: System.Drawing.GraphicsUnit

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

Type: System.Drawing.Imaging.ImageAttributes

ImageAttributes that specifies recoloring and gamma information for image.

Type: System.Drawing.Graphics.DrawImageAbort

Graphics.DrawImageAbort delegate that specifies a method to call during the drawing of the image. This method is called frequently to check whether to stop execution of the DrawImage method according to application-determined criteria.

Exception Condition

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 object.

This overload with the callback parameter provides the means to stop the drawing of an image once it starts according to criteria determined by the application. For example, an application could start drawing a large image and the user might scroll the image off the screen, in which case the application could stop the drawing.

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 first defines a callback method for the Graphics.DrawImageAbort delegate; the definition is simplistic and merely tests to see whether the DrawImage method calls it with a null callBackData parameter. The main body of the example performs the following actions:

  • Creates an instance of the Graphics.DrawImageAbort callback method.

  • Creates an image from a JPEG file SampImag.jpg in the folder of the example.

  • Creates points that define a destination rectangle in which to draw the image.

  • Creates a source rectangle to select the portion of the image to draw.

  • Sets the graphics drawing unit to pixel.

  • Draws the original image to the screen.

  • Creates an additional destination rectangle in which to draw an adjusted image.

  • Creates and sets the attributes of the adjusted image to have a larger-than-usual gamma value.

  • Draws the adjusted image to the screen.

For the original, unadjusted destination rectangle, the position locates the image on the screen, and the size of the source rectangle and the size and shape of the destination rectangle determines the scaling of the drawn image.

Because this example uses an overload that does not pass a callBackData parameter, the Graphics.DrawImageAbort callback returns true, which causes the DrawImage method to end, and the exception-handling code included in the example prints out the exception text rather than drawing the image.

Private Function DrawImageCallback5(ByVal callBackData As IntPtr) As Boolean

    ' Test for call that passes callBackData parameter.
    If callBackData.Equals(IntPtr.Zero) Then

        ' If no callBackData passed, abort DrawImage method.
        Return True

        ' If callBackData passed, continue DrawImage method.
        Return False
    End If
End Function
Private Sub DrawImageRect4IntAtrribAbort(ByVal e As PaintEventArgs)

    ' Create callback method.
    Dim imageCallback As New _
    Graphics.DrawImageAbort(AddressOf DrawImageCallback5)

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

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

    ' Create coordinates of rectangle for source image.
    Dim x As Integer = 50
    Dim y As Integer = 50
    Dim width As Integer = 150
    Dim height As Integer = 150
    Dim units As GraphicsUnit = GraphicsUnit.Pixel

    ' Draw original image to screen.
    e.Graphics.DrawImage(newImage, destRect1, x, y, width, height, _

    ' Create rectangle for adjusted image.
    Dim destRect2 As New Rectangle(100, 175, 450, 150)

    ' Create image attributes and set large gamma.
    Dim imageAttr As New ImageAttributes

        ' Draw adjusted image to screen.
        e.Graphics.DrawImage(newImage, destRect2, x, y, width, _
        height, units, imageAttr, imageCallback)
    Catch ex As Exception
        e.Graphics.DrawString(ex.ToString(), New Font("Arial", 8), _
        Brushes.Black, New PointF(0, 0))
    End Try
End Sub

.NET Framework
Available since 1.1
Return to top