Graphics::DrawIcon Method (Icon^, Rectangle)

 
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.

Draws the image represented by the specified Icon within the area specified by a Rectangle structure.

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

public:
void DrawIcon(
	Icon^ icon,
	Rectangle targetRect
)

Parameters

icon
Type: System.Drawing::Icon^

Icon to draw.

targetRect
Type: System.Drawing::Rectangle

Rectangle structure that specifies the location and size of the resulting image on the display surface. The image contained in the icon parameter is scaled to the dimensions of this rectangular area.

Exception Condition
ArgumentNullException

icon is null.

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 an icon from a standard Windows icon file SampIcon.ico in the example folder.

  • Creates a rectangle in which to draw the icon.

  • Draws the icon to the screen.

The position of the rectangle locates the icon on the screen, and the size of the rectangle determines the scaling of the drawn icon.

private:
   void DrawIconRectangle( PaintEventArgs^ e )
   {
      // Create icon.
      System::Drawing::Icon^ newIcon = gcnew System::Drawing::Icon( "SampIcon.ico" );

      // Create rectangle for icon.
      Rectangle rect = Rectangle(100,100,200,200);

      // Draw icon to screen.
      e->Graphics->DrawIcon( newIcon, rect );
   }

.NET Framework
Available since 1.1
Return to top
Show: