.NET Framework Class Library
Graphics..::.FromImage Method

Creates a new Graphics from the specified Image.

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

Visual Basic (Declaration)
Public Shared Function FromImage ( _
    image As Image _
) As Graphics
Visual Basic (Usage)
Dim image As Image
Dim returnValue As Graphics

returnValue = Graphics.FromImage(image)
C#
public static Graphics FromImage(
    Image image
)
Visual C++
public:
static Graphics^ FromImage(
    Image^ image
)
JScript
public static function FromImage(
    image : Image
) : Graphics

Parameters

image
Type: System.Drawing..::.Image
Image from which to create the new Graphics.

Return Value

Type: System.Drawing..::.Graphics
This method returns a new Graphics for the specified Image.
Exceptions

ExceptionCondition
ArgumentNullException

image is nullNothingnullptra null reference (Nothing in Visual Basic).

Exception

image has an indexed pixel format or its format is undefined.

Remarks

If the image has an indexed pixel format, this method throws an exception with the message, "A Graphics object cannot be created from an image that has an indexed pixel format." The indexed pixel formats are shown in the following list.

This method also throws an exception if the image has any of the following pixel formats.

You should always call the Dispose method to release the Graphics and related resources created by the FromImage method.

Examples

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 action:

  • Creates an Image from a graphics file SampImag.jpg in the example folder.

  • Creates a Graphics from the Image.

  • Alters the image by filling a rectangle within it.

  • Draws the Image to the screen.

  • Releases the created Graphics.

Visual Basic
Private Sub FromImageImage2(ByVal e As PaintEventArgs)

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

    ' Create graphics object for alteration.
    Dim newGraphics As Graphics = Graphics.FromImage(imageFile)

    ' Alter image.
    newGraphics.FillRectangle(New SolidBrush(Color.Black), _
    100, 50, 100, 100)

    ' Draw image to screen.
    e.Graphics.DrawImage(imageFile, New PointF(0.0F, 0.0F))

    ' Dispose of graphics object.
    newGraphics.Dispose()
End Sub
C#
private void FromImageImage(PaintEventArgs e)
{

    // Create image.
    Image imageFile = Image.FromFile("SampImag.jpg");

    // Create graphics object for alteration.
    Graphics newGraphics = Graphics.FromImage(imageFile);

    // Alter image.
    newGraphics.FillRectangle(new SolidBrush(Color.Black), 100, 50, 100, 100);

    // Draw image to screen.
    e.Graphics.DrawImage(imageFile, new PointF(0.0F, 0.0F));

    // Dispose of graphics object.
    newGraphics.Dispose();
}
Platforms

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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.
Version Information

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
See Also

Reference

Other Resources

Tags :


Page view tracker