[API Proposal]: DrawRectangle should accept RectangleF as one of the overloads

[medo64]

Background and motivation

In Graphics class, FillRectangle contains the following 4 overloads:

• public void FillRectangle(Brush brush, RectangleF rect)
• public void FillRectangle(Brush brush, float x, float y, float width, float height)
• public void FillRectangle(Brush brush, Rectangle rect)
• public void FillRectangle(Brush brush, int x, int y, int width, int height)

However, DrawRectangle, contains only the following 3 overloads:

• public void DrawRectangle(Pen pen, Rectangle rect)
• public void DrawRectangle(Pen pen, float x, float y, float width, float height)
• public void DrawRectangle(Pen pen, int x, int y, int width, int height)

In the interest of symmetry, I propose adding the "missing" RectangleF overload:

• public void DrawRectangle(Pen pen, RectangleF rect)

During a development process one can quite often switch between DrawRectangle and FillRectangle API. This would allow to do so without changing the variables around, i.e. just by changing Fill into Draw and backward. Likewise, this would make drawing filled rectangles with outline in different color minutely easier.

API Proposal

namespace System.Drawing.Common
{
    public class Graphics
    {
        public void DrawRectangle(Pen pen, RectangleF rect);
    }
}

API Usage

API usage would be comparable to the existing API:

var rect = new RectangleF(...);
e.Graphics.FillRectangle(Brushes.Blue, rect);  // this works even now
e.Graphics.DrawRectangle(Pens.Red, rect);      // this would be a new overload

Alternative Designs

No response

Risks

Since method will just be a convenient way of calling already existing overload, risk is minimal if any.

[ghost]

Tagging subscribers to this area: @dotnet/area-system-drawing
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Background and motivation

In Graphics class, FillRectangle contains the following 4 overloads:

• public void FillRectangle(Brush brush, RectangleF rect)
• public void FillRectangle(Brush brush, float x, float y, float width, float height)
• public void FillRectangle(Brush brush, Rectangle rect)
• public void FillRectangle(Brush brush, int x, int y, int width, int height)

However, DrawRectangle, contains only the following 3 overloads:

• public void DrawRectangle(Pen pen, Rectangle rect)
• public void DrawRectangle(Pen pen, float x, float y, float width, float height)
• public void DrawRectangle(Pen pen, int x, int y, int width, int height)

In the interest of symmetry, I propose adding the "missing" RectangleF overload:

• public void DrawRectangle(Pen pen, RectangleF rect)

During a development process one can quite often switch between DrawRectangle and FillRectangle API. This would allow to do so without changing the variables around, i.e. just by changing Fill into Draw and backward. Likewise, this would make drawing filled rectangles with outline in different color minutely easier.

API usage would be comparable to the existing API:

var rect = new RectangleF(...);
e.Graphics.FillRectangle(Brushes.Blue, rect);  // this works even now
e.Graphics.DrawRectangle(Pens.Red, rect);      // this would be a new overload

API Proposal

namespace System.Collections.Generic
{
    public class MyFancyCollection<T> : IEnumerable<T>
    {
        public void Fancy(T item);
    }
}

API Usage

// Fancy the value
var c = new MyFancyCollection<int>();
c.Fancy(42);

// Getting the values out
foreach (var v in c)
    Console.WriteLine(v);

Alternative Designs

No response

Risks

No response

Author:	medo64
Assignees:	-
Labels:	api-suggestion, area-System.Drawing, untriaged
Milestone:	-

[safern]

Makes sense to add this overload to be consistent with what we have on other APIs, i.e Graphics.FillRectangle.

Marking it as api-ready-for-review to discuss it on the review meeting.

[terrajobst]

Video

• Seems like a no-brainer
  • Are there any other? Seems like FillPie would be in the same category.

namespace System.Drawing.Common
{
    public partial class Graphics
    {
        public void DrawRectangle(Pen pen, RectangleF rect);
        public void FillPie(Brush brush, RectangleF rect, float startAngle, float sweepAngle);
    }
}

[medo64]

• Seems like a no-brainer
  • Are there any other? Seems like FillPie would be in the same category.

Agreed; missed that one. I believe FillPie is the only one missing RectangleF but having Rectangle. There is a DrawIcon but there I believe having just Rectangle is appropriate.

[medo64]

I did ask for pull request to be reopened (yes, I did things slightly out of order). Once that happens I will push commit for FillPie in addition to DrawRectangle that was already part of original pull request.

[deeprobin]

Please tag this with "in pr" 😄 thank you

[jeffhandley]

This was completed in #62385