This documentation is archived and is not being maintained.

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

.NET Framework 1.1

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

[Visual Basic]
Overloads Public Sub DrawImage( _
   ByVal image As Image, _
   ByVal destRect As Rectangle, _
   ByVal srcX As Single, _
   ByVal srcY As Single, _
   ByVal srcWidth As Single, _
   ByVal srcHeight As Single, _
   ByVal srcUnit As GraphicsUnit, _
   ByVal imageAttrs As ImageAttributes _
)
[C#]
public void DrawImage(
 Image image,
 Rectangle destRect,
 float srcX,
 float srcY,
 float srcWidth,
 float srcHeight,
 GraphicsUnit srcUnit,
 ImageAttributes imageAttrs
);
[C++]
public: void DrawImage(
 Image* image,
 Rectangle destRect,
 float srcX,
 float srcY,
 float srcWidth,
 float srcHeight,
 GraphicsUnit srcUnit,
 ImageAttributes* imageAttrs
);
[JScript]
public function DrawImage(
   image : Image,
 destRect : Rectangle,
 srcX : float,
 srcY : float,
 srcWidth : float,
 srcHeight : float,
 srcUnit : GraphicsUnit,
 imageAttrs : ImageAttributes
);

Parameters

image
Image object to draw.
destRect
Rectangle structure that specifies the location and size of the drawn image. The image is scaled to fit the rectangle.
srcX
x-coordinate of the upper-left corner of the portion of the source image to draw.
srcY
y-coordinate of the upper-left corner of the portion of the source image to draw.
srcWidth
Width of the portion of the source image to draw.
srcHeight
Height of the portion of the source image to draw.
srcUnit
Member of the GraphicsUnit enumeration that specifies the units of measure used to determine the source rectangle.
imageAttrs
ImageAttributes object that specifies recoloring and gamma information for the image object.

Return Value

This method does not return a value.

Remarks

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.

Example

[Visual Basic, C#] The following 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 an image from a JPEG file SampImag.jpg in the folder of the example.
  • Creates a destination rectangle in which to draw the image.
  • Creates the coordinates of 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 original image to the screen.
  • Creates an additional 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.

[Visual Basic, C#] For the original, unadjusted destination rectangle, the position locates the image on the screen, and 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.

[Visual Basic] 
Public Sub DrawImageRect4FloatAttrib(e As PaintEventArgs)
' 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 Single = 50F
Dim y As Single = 50F
Dim width As Single = 150F
Dim height As Single = 150F
Dim units As GraphicsUnit = GraphicsUnit.Pixel
' Draw original image to screen.
e.Graphics.DrawImage(newImage, destRect1, x, y, width, _
height, units)
' 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()
imageAttr.SetGamma(4F)
' Draw adjusted image to screen.
e.Graphics.DrawImage(newImage, destRect2, x, y, width, height, _
units, imageAttr)
End Sub
        
[C#] 
public void DrawImageRect4FloatAttrib(PaintEventArgs e)
{
// Create image.
Image newImage = Image.FromFile("SampImag.jpg");
// Create rectangle for displaying original image.
Rectangle destRect1 = new Rectangle( 100, 25, 450, 150);
// Create coordinates of rectangle for source image.
float x = 50.0F;
float y = 50.0F;
float width = 150.0F;
float height = 150.0F;
GraphicsUnit units = GraphicsUnit.Pixel;
// Draw original image to screen.
e.Graphics.DrawImage(newImage, destRect1, x, y, width, height, units);
// Create rectangle for adjusted image.
Rectangle destRect2 = new Rectangle(100, 175, 450, 150);
// Create image attributes and set large gamma.
ImageAttributes imageAttr = new ImageAttributes();
imageAttr.SetGamma(4.0F);
// Draw adjusted image to screen.
e.Graphics.DrawImage(newImage, destRect2, x, y, width, height, units, imageAttr);
}
        

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Graphics Class | Graphics Members | System.Drawing Namespace | Graphics.DrawImage Overload List

Show: