Icon.FromHandle Method (IntPtr)

 
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.

Creates a GDI+ Icon from the specified Windows handle to an icon (HICON).

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

public static Icon FromHandle(
	IntPtr handle
)

Parameters

handle
Type: System.IntPtr

A Windows handle to an icon.

Return Value

Type: System.Drawing.Icon

The Icon this method creates.

When using this method, you must dispose of the original icon by using the DestroyIcon method in the Win32 API to ensure that the resources are released.

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 a Bitmap.

  • Draws that object to the screen.

  • Gets an icon handle for the Bitmap.

  • Sets the Form.Icon attribute of the form to an icon created from the handle.

  • Calls the Win32 API function DestroyIcon to release resources.


[System.Runtime.InteropServices.DllImport("user32.dll", CharSet = CharSet.Auto)]
extern static bool DestroyIcon(IntPtr handle);

private void GetHicon_Example(PaintEventArgs e)
{

    // Create a Bitmap object from an image file.
    Bitmap myBitmap = new Bitmap(@"c:\FakePhoto.jpg");

    // Draw myBitmap to the screen.
    e.Graphics.DrawImage(myBitmap, 0, 0);

    // Get an Hicon for myBitmap.
    IntPtr Hicon = myBitmap.GetHicon();

    // Create a new icon from the handle. 
    Icon newIcon = Icon.FromHandle(Hicon);

    // Set the form Icon attribute to the new icon.
    this.Icon = newIcon;

    // You can now destroy the icon, since the form creates
    // its own copy of the icon accessible through the Form.Icon property.
    DestroyIcon(newIcon.Handle);

}

SecurityPermission

for access to unmanaged code. Related enumeration UnmanagedCode.

.NET Framework
Available since 1.1
Return to top
Show: