Export (0) Print
Expand All
Expand Minimize

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

.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, _
   ByVal callback As Graphics.DrawImageAbort, _
   ByVal callbackData As IntPtr _
)
[C#]
public void DrawImage(
 Image image,
 Rectangle destRect,
 float srcX,
 float srcY,
 float srcWidth,
 float srcHeight,
 GraphicsUnit srcUnit,
 ImageAttributes imageAttrs,
 Graphics.DrawImageAbort callback,
 IntPtr callbackData
);
[C++]
public: void DrawImage(
 Image* image,
 Rectangle destRect,
 float srcX,
 float srcY,
 float srcWidth,
 float srcHeight,
 GraphicsUnit srcUnit,
 ImageAttributes* imageAttrs,
 Graphics.DrawImageAbort* callback,
 IntPtr callbackData
);
[JScript]
public function DrawImage(
   image : Image,
 destRect : Rectangle,
 srcX : float,
 srcY : float,
 srcWidth : float,
 srcHeight : float,
 srcUnit : GraphicsUnit,
 imageAttrs : ImageAttributes,
 callback : Graphics.DrawImageAbort,
 callbackData : IntPtr
);

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.
callback
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.
callbackData
Value specifying additional data for the DrawImageAbort delegate to use when checking whether to stop execution of the DrawImage method.

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.

This overload with the callback and callbackData parameters provides the means to stop the drawing of an image once it starts according to criteria and data 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.

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 first defines a callback method for the 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 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.

[Visual Basic, C#] 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.

[Visual Basic, C#] Because this example uses an overload that passes a callBackData parameter, the DrawImageAbort callback returns false, which causes the DrawImage method to continue, and the example draws the adjusted image to the screen.

[Visual Basic] 
Private Function DrawImageCallback(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
Else
' If callBackData passed, continue DrawImage method.
Return False
End If
End Function
Public Sub DrawImageRect4FloatAttribAbortData(e As PaintEventArgs)
' Create callback method.
Dim imageCallback As New _
Graphics.DrawImageAbort(AddressOf DrawImageCallback)
Dim imageCallbackData As New IntPtr(1)
' 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.
Try
' Draw adjusted image to screen.
e.Graphics.DrawImage(newImage, destRect2, x, y, width, _
height, units, imageAttr, imageCallback, imageCallbackData)
Catch ex As Exception
e.Graphics.DrawString(ex.ToString(), New Font("Arial", 8), _
Brushes.Black, New PointF(0, 0))
End Try
End Sub
        
[C#] 
// Define DrawImageAbort callback method.
private bool DrawImageCallback(IntPtr callBackData)
{
// Test for call that passes callBackData parameter.
if(callBackData==IntPtr.Zero)
{
// If no callBackData passed, abort DrawImage method.
return true;
}
else
{
// If callBackData passed, continue DrawImage method.
return false;
}
}
public void DrawImageRect4FloatAttribAbortData(PaintEventArgs e)
{
// Create callback method.
Graphics.DrawImageAbort imageCallback
= new Graphics.DrawImageAbort(DrawImageCallback);
IntPtr imageCallbackData = new IntPtr(1);
// 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.
try
{
checked
{
// Draw adjusted image to screen.
e.Graphics.DrawImage(
newImage,
destRect2,
x, y,
width, height,
units,
imageAttr,
imageCallback,
imageCallbackData);
}
}
catch (Exception ex)
{
e.Graphics.DrawString(
ex.ToString(),
new Font("Arial", 8),
Brushes.Black,
new PointF(0, 0));
}
}
        

[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:
© 2014 Microsoft