Graphics.DrawIconUnstretched(Icon, Rectangle) Method

Definition

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

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

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

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.

C#
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);
}

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0 (package-provided)
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9, 10