Skip to content

Commit a877aad

Browse files
authored
add note about non-windows os (#6944)
1 parent 4959242 commit a877aad

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+13087
-12985
lines changed

includes/system-drawing-common.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
> [!NOTE]
2+
> In .NET 6 and later versions, the [System.Drawing.Common package](https://www.nuget.org/packages/System.Drawing.Common/), which includes this type, is only supported on Windows operating systems. Use of this type in cross-platform apps causes compile-time warnings and run-time exceptions. For more information, see [System.Drawing.Common only supported on Windows](/dotnet/core/compatibility/core-libraries/6.0/system-drawing-common-windows-only).

xml/System.Drawing.Drawing2D/AdjustableArrowCap.xml

+45-37
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,15 @@
2626
<Interfaces />
2727
<Docs>
2828
<summary>Represents an adjustable arrow-shaped line cap. This class cannot be inherited.</summary>
29-
<remarks>To be added.</remarks>
29+
<remarks>
30+
<format type="text/markdown"><![CDATA[
31+
32+
## Remarks
33+
34+
[!INCLUDE[System.Drawing.Common note](~/includes/system-drawing-common.md)]
35+
36+
]]></format>
37+
</remarks>
3038
</Docs>
3139
<Members>
3240
<MemberGroup MemberName=".ctor">
@@ -76,21 +84,21 @@
7684
<param name="height">The height of the arrow.</param>
7785
<summary>Initializes a new instance of the <see cref="T:System.Drawing.Drawing2D.AdjustableArrowCap" /> class with the specified width and height. The arrow end caps created with this constructor are always filled.</summary>
7886
<remarks>
79-
<format type="text/markdown"><![CDATA[
80-
81-
## Examples
82-
The following example is designed for use with Windows Forms, and it requires <xref:System.Windows.Forms.PaintEventArgs>`e`, an <xref:System.Windows.Forms.Control.OnPaint%2A> event object. The code performs the following actions:
83-
84-
- Creates an <xref:System.Drawing.Drawing2D.AdjustableArrowCap> object named `myArrow`.
85-
86-
- Creates a <xref:System.Drawing.Pen> object named `capPen`, and sets its <xref:System.Drawing.Pen.CustomStartCap%2A> and <xref:System.Drawing.Pen.CustomEndCap%2A> properties equal to `myArrow`.
87-
88-
- Uses the <xref:System.Drawing.Graphics.DrawLine%2A> method to draw to screen a line capped by two arrows.
89-
87+
<format type="text/markdown"><![CDATA[
88+
89+
## Examples
90+
The following example is designed for use with Windows Forms, and it requires <xref:System.Windows.Forms.PaintEventArgs>`e`, an <xref:System.Windows.Forms.Control.OnPaint%2A> event object. The code performs the following actions:
91+
92+
- Creates an <xref:System.Drawing.Drawing2D.AdjustableArrowCap> object named `myArrow`.
93+
94+
- Creates a <xref:System.Drawing.Pen> object named `capPen`, and sets its <xref:System.Drawing.Pen.CustomStartCap%2A> and <xref:System.Drawing.Pen.CustomEndCap%2A> properties equal to `myArrow`.
95+
96+
- Uses the <xref:System.Drawing.Graphics.DrawLine%2A> method to draw to screen a line capped by two arrows.
97+
9098
:::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Drawing.Drawing2D.ClassicMisc/CPP/form1.cpp" id="Snippet1":::
9199
:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Drawing.Drawing2D.ClassicMisc/CS/form1.cs" id="Snippet1":::
92-
:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Drawing2D.ClassicMisc/VB/form1.vb" id="Snippet1":::
93-
100+
:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Drawing2D.ClassicMisc/VB/form1.vb" id="Snippet1":::
101+
94102
]]></format>
95103
</remarks>
96104
</Docs>
@@ -130,21 +138,21 @@
130138
<see langword="true" /> to fill the arrow cap; otherwise, <see langword="false" />.</param>
131139
<summary>Initializes a new instance of the <see cref="T:System.Drawing.Drawing2D.AdjustableArrowCap" /> class with the specified width, height, and fill property. Whether an arrow end cap is filled depends on the argument passed to the <paramref name="isFilled" /> parameter.</summary>
132140
<remarks>
133-
<format type="text/markdown"><![CDATA[
134-
135-
## Examples
136-
The following example is designed for use with Windows Forms, and it requires <xref:System.Windows.Forms.PaintEventArgs>`e`, an <xref:System.Windows.Forms.Control.OnPaint%2A> event object. The code performs the following actions:
137-
138-
- Creates an <xref:System.Drawing.Drawing2D.AdjustableArrowCap> object named `myArrow`.
139-
140-
- Creates a <xref:System.Drawing.Pen> object named `capPen`, and sets its <xref:System.Drawing.Pen.CustomStartCap%2A> and <xref:System.Drawing.Pen.CustomEndCap%2A> properties equal to `myArrow`.
141-
142-
- Uses the <xref:System.Drawing.Graphics.DrawLine%2A> method to draw to screen a line capped by two arrows.
143-
141+
<format type="text/markdown"><![CDATA[
142+
143+
## Examples
144+
The following example is designed for use with Windows Forms, and it requires <xref:System.Windows.Forms.PaintEventArgs>`e`, an <xref:System.Windows.Forms.Control.OnPaint%2A> event object. The code performs the following actions:
145+
146+
- Creates an <xref:System.Drawing.Drawing2D.AdjustableArrowCap> object named `myArrow`.
147+
148+
- Creates a <xref:System.Drawing.Pen> object named `capPen`, and sets its <xref:System.Drawing.Pen.CustomStartCap%2A> and <xref:System.Drawing.Pen.CustomEndCap%2A> properties equal to `myArrow`.
149+
150+
- Uses the <xref:System.Drawing.Graphics.DrawLine%2A> method to draw to screen a line capped by two arrows.
151+
144152
:::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_Winforms/System.Drawing.Drawing2D.ClassicMisc/CPP/form1.cpp" id="Snippet2":::
145153
:::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_Winforms/System.Drawing.Drawing2D.ClassicMisc/CS/form1.cs" id="Snippet2":::
146-
:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Drawing2D.ClassicMisc/VB/form1.vb" id="Snippet2":::
147-
154+
:::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Drawing.Drawing2D.ClassicMisc/VB/form1.vb" id="Snippet2":::
155+
148156
]]></format>
149157
</remarks>
150158
</Docs>
@@ -231,11 +239,11 @@
231239
<summary>Gets or sets the height of the arrow cap.</summary>
232240
<value>The height of the arrow cap.</value>
233241
<remarks>
234-
<format type="text/markdown"><![CDATA[
235-
236-
## Remarks
237-
The height of the arrow cap is scaled by the width of the <xref:System.Drawing.Pen> object used to draw the line being capped. For example, if you are drawing a capped line with a pen that has a width of 5 pixels, and the <xref:System.Drawing.Drawing2D.AdjustableArrowCap> object has a height of 3, then the actual arrow cap is drawn 15 pixels high.
238-
242+
<format type="text/markdown"><![CDATA[
243+
244+
## Remarks
245+
The height of the arrow cap is scaled by the width of the <xref:System.Drawing.Pen> object used to draw the line being capped. For example, if you are drawing a capped line with a pen that has a width of 5 pixels, and the <xref:System.Drawing.Drawing2D.AdjustableArrowCap> object has a height of 3, then the actual arrow cap is drawn 15 pixels high.
246+
239247
]]></format>
240248
</remarks>
241249
</Docs>
@@ -322,11 +330,11 @@
322330
<summary>Gets or sets the width of the arrow cap.</summary>
323331
<value>The width, in units, of the arrow cap.</value>
324332
<remarks>
325-
<format type="text/markdown"><![CDATA[
326-
327-
## Remarks
328-
The width of the arrow cap is scaled by the width of the <xref:System.Drawing.Pen> object used to draw the line being capped. For example, if you are drawing a capped line with a pen that has a width of 5 pixels, and the <xref:System.Drawing.Drawing2D.AdjustableArrowCap> object has a width of 3, then the actual arrow cap is drawn 15 pixels wide.
329-
333+
<format type="text/markdown"><![CDATA[
334+
335+
## Remarks
336+
The width of the arrow cap is scaled by the width of the <xref:System.Drawing.Pen> object used to draw the line being capped. For example, if you are drawing a capped line with a pen that has a width of 5 pixels, and the <xref:System.Drawing.Drawing2D.AdjustableArrowCap> object has a width of 3, then the actual arrow cap is drawn 15 pixels wide.
337+
330338
]]></format>
331339
</remarks>
332340
</Docs>

0 commit comments

Comments
 (0)