Graphics.DrawIconUnstretched(Icon, Rectangle) Method

Definition

Namespace:

System.Drawing

Assembly:

System.Drawing.Common.dll

Package:

System.Drawing.Common v8.0.0

Source:

Graphics.cs

Draws the image represented by the specified Icon without scaling the image.

public:
 void DrawIconUnstretched(System::Drawing::Icon ^ icon, System::Drawing::Rectangle targetRect);

public void DrawIconUnstretched (System.Drawing.Icon icon, System.Drawing.Rectangle targetRect);

member this.DrawIconUnstretched : System.Drawing.Icon * System.Drawing.Rectangle -> unit

Public Sub DrawIconUnstretched (icon As Icon, targetRect As Rectangle)

Parameters

icon

Icon

Icon to draw.

targetRect

Rectangle

Rectangle structure that specifies the location and size of the resulting image. The image is not scaled to fit this rectangle, but retains its original size. If the image is larger than the rectangle, it is clipped to fit inside it.

Exceptions

ArgumentNullException

icon is null.

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 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 drawn icon is unscaled and unclipped.

private:
   void DrawIconUnstretchedRectangle( 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->DrawIconUnstretched( newIcon, rect );
   }

private void DrawIconUnstretchedRectangle(PaintEventArgs e)
{
    // Create icon.
    Icon newIcon = new Icon("SampIcon.ico");
             
    // Create rectangle for icon.
    Rectangle rect = new Rectangle(100, 100, 200, 200);
             
    // Draw icon to screen.
    e.Graphics.DrawIconUnstretched(newIcon, rect);
}

Private Sub DrawIconUnstretchedRectangle(ByVal e As PaintEventArgs)

    ' Create icon.
    Dim newIcon As New Icon("SampIcon.ico")

    ' Create rectangle for icon.
    Dim rect As New Rectangle(100, 100, 200, 200)

    ' Draw icon to screen.
    e.Graphics.DrawIconUnstretched(newIcon, rect)
End Sub