Files
linux-packaging-mono/mcs/class/System.Drawing/Documentation/en/System.Drawing/Pen.xml
Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

874 lines
48 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="Pen" FullName="System.Drawing.Pen">
<TypeSignature Language="C#" Maintainer="auto" Value="public sealed class Pen : MarshalByRefObject, ICloneable, IDisposable" />
<AssemblyInfo>
<AssemblyName>System.Drawing</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 07 D1 FA 57 C4 AE D9 F0 A3 2E 84 AA 0F AE FD 0D E9 E8 FD 6A EC 8F 87 FB 03 76 6C 83 4C 99 92 1E B2 3B E7 9A D9 D5 DC C1 DD 9A D2 36 13 21 02 90 0B 72 3C F9 80 95 7F C4 E1 77 10 8F C6 07 77 4F 29 E8 32 0E 92 EA 05 EC E4 E8 21 C0 A5 EF E8 F1 64 5C 4C 0C 93 C1 AB 99 28 5D 62 2C AA 65 2C 1D FA D6 3D 74 5D 6F 2D E5 F1 7E 5E AF 0F C4 96 3D 26 1C 8A 12 43 65 18 20 6D C0 93 34 4D 5A D2 93]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>System.MarshalByRefObject</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ICloneable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Drawing.Pen" /> draws a line of specified width and style. Use the <see cref="T:System.Drawing.Drawing2D.DashStyle" /> property to draw several varieties of dashed lines. The line drawn by a <see cref="T:System.Drawing.Pen" /> can be filled in a variety of fill styles, including solid colors and textures. The fill style depends on brush or texture that is used as the fill object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines an object used to draw lines and curves. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Pen (System.Drawing.Brush brush);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="brush" Type="System.Drawing.Brush" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Drawing.Pen.Brush" /> property determines how the <see cref="T:System.Drawing.Pen" /> draws lines. Lines are drawn as if they are filled rectangles, with the characteristics of the specified <see cref="T:System.Drawing.Brush" />.</para>
<para>The <see cref="P:System.Drawing.Pen.Width" /> property of the new <see cref="T:System.Drawing.Pen" /> is set to 1 (the default).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Drawing.Pen" /> class with the specified <see cref="T:System.Drawing.Brush" />.</para>
</summary>
<param name="brush">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Brush" /> that determines the fill properties of this <see cref="T:System.Drawing.Pen" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Pen (System.Drawing.Color color);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="color" Type="System.Drawing.Color" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Drawing.Color" /> property is set to the color specified by the <paramref name="color" /> parameter. The <see cref="P:System.Drawing.Pen.Width" /> property is set to 1 (the default).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Drawing.Pen" /> class with the specified color.</para>
</summary>
<param name="color">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Color" /> structure that indicates the color of this <see cref="T:System.Drawing.Pen" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Pen (System.Drawing.Brush brush, float width);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="brush" Type="System.Drawing.Brush" />
<Parameter Name="width" Type="System.Single" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Drawing.Brush" /> is set to the color specified in the <paramref name="brush" /> parameter, the <see cref="P:System.Drawing.Pen.Width" /> property is set to the value specified in the <paramref name="width" /> parameter, and the units are set to <see cref="F:System.Drawing.GraphicsUnit.World" />.</para>
<para>Note that the <paramref name="brush" /> parameter also specifies the <see cref="T:System.Drawing.Color" /> property of this <see cref="T:System.Drawing.Pen" />.</para>
<para>A <paramref name="width" /> of 0 will result in the <see cref="T:System.Drawing.Pen" /> drawing as if the width were 1.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Drawing.Pen" /> class with the specified <see cref="T:System.Drawing.Brush" /> and <see cref="P:System.Drawing.Pen.Width" />.</para>
</summary>
<param name="brush">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Brush" /> that determines the characteristics of this <see cref="T:System.Drawing.Pen" />. </param>
<param name="width">
<attribution license="cc4" from="Microsoft" modified="false" />The width of the new <see cref="T:System.Drawing.Pen" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Pen (System.Drawing.Color color, float width);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="color" Type="System.Drawing.Color" />
<Parameter Name="width" Type="System.Single" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Drawing.Color" /> property is set to the color specified by the <paramref name="color" /> parameter. The <see cref="P:System.Drawing.Pen.Width" /> property is set to the value specified in the <paramref name="width" /> parameter. A <paramref name="width" /> of 0 will result in the <see cref="T:System.Drawing.Pen" /> drawing as if the width were 1.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Drawing.Pen" /> class with the specified <see cref="T:System.Drawing.Color" /> and <see cref="P:System.Drawing.Pen.Width" /> properties.</para>
</summary>
<param name="color">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Color" /> structure that indicates the color of this <see cref="T:System.Drawing.Pen" />. </param>
<param name="width">
<attribution license="cc4" from="Microsoft" modified="false" />A value indicating the width of this <see cref="T:System.Drawing.Pen" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Alignment">
<MemberSignature Language="C#" Value="public System.Drawing.Drawing2D.PenAlignment Alignment { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Drawing2D.PenAlignment</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Drawing2D.PenAlignment'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This property determines how the <see cref="T:System.Drawing.Pen" /> draws closed curves and polygons. The <see cref="T:System.Drawing.Drawing2D.PenAlignment" /> enumeration specifies five values; however, only two values—<see cref="F:System.Drawing.Drawing2D.PenAlignment.Center" /> and <see cref="F:System.Drawing.Drawing2D.PenAlignment.Inset" />—will change the appearance of a drawn line. <see cref="F:System.Drawing.Drawing2D.PenAlignment.Center" /> is the default value for this property and specifies that the width of the pen is centered on the outline of the curve or polygon. A value of <see cref="F:System.Drawing.Drawing2D.PenAlignment.Inset" /> for this property specifies that the width of the pen is inside the outline of the curve or polygon. The other three values, <see cref="F:System.Drawing.Drawing2D.PenAlignment.Right" />, <see cref="F:System.Drawing.Drawing2D.PenAlignment.Left" />, and <see cref="F:System.Drawing.Drawing2D.PenAlignment.Outset" />, will result in a pen that is centered.</para>
<para>A <see cref="T:System.Drawing.Pen" /> that has its alignment set to <see cref="F:System.Drawing.Drawing2D.PenAlignment.Inset" /> will yield unreliable results, sometimes drawing in the inset position and sometimes in the centered position. Also, an inset pen cannot be used to draw compound lines and cannot draw dashed lines with <see cref="F:System.Drawing.Drawing2D.DashCap.Triangle" /> dash caps.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the alignment for this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Brush">
<MemberSignature Language="C#" Value="public System.Drawing.Brush Brush { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Brush</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Brush'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Assigning this property causes the pen to draw filled lines and curves. It overrides the <see cref="T:System.Drawing.Color" /> property of the <see cref="T:System.Drawing.Pen" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the <see cref="T:System.Drawing.Brush" /> that determines attributes of this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public object Clone ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates an exact copy of this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An <see cref="T:System.Object" /> that can be cast to a <see cref="T:System.Drawing.Pen" />.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Color">
<MemberSignature Language="C#" Value="public System.Drawing.Color Color { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Color</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Color'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the color of this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CompoundArray">
<MemberSignature Language="C#" Value="public float[] CompoundArray { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single[]</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'float []'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A compound line is made up of alternating parallel lines and spaces of varying widths. The values in the array specify the starting points of each component of the compound line relative to the pen's width. The first value in the array specifies where the first component (a line) begins as a fraction of the distance across the width of the pen. The second value in the array specifies the beginning of the next component (a space) as a fraction of the distance across the width of the pen. The final value in the array specifies where the last component ends.</para>
<para>Suppose you want a pen to draw two parallel lines where the width of the first line is 20 percent of the pen's width, the width of the space that separates the two lines is 50 percent of the pen' s width, and the width of the second line is 30 percent of the pen's width. Start by creating a <see cref="T:System.Drawing.Pen" /> and an array of real numbers. Set the compound array by passing the array with the values 0.0, 0.2, 0.7, and 1.0 to this property.</para>
<para>Do not set this property if the <see cref="T:System.Drawing.Pen" /> has its <see cref="P:System.Drawing.Pen.Alignment" /> property set to <see cref="F:System.Drawing.Drawing2D.PenAlignment.Inset" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets an array of values that specifies a compound pen. A compound pen draws a compound line made up of parallel lines and spaces.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CustomEndCap">
<MemberSignature Language="C#" Value="public System.Drawing.Drawing2D.CustomLineCap CustomEndCap { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Drawing2D.CustomLineCap</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Drawing2D.CustomLineCap'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a custom cap to use at the end of lines drawn with this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CustomStartCap">
<MemberSignature Language="C#" Value="public System.Drawing.Drawing2D.CustomLineCap CustomStartCap { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Drawing2D.CustomLineCap</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Drawing2D.CustomLineCap'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a custom cap to use at the beginning of lines drawn with this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DashCap">
<MemberSignature Language="C#" Value="public System.Drawing.Drawing2D.DashCap DashCap { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Drawing2D.DashCap</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Drawing2D.DashCap'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Do not set this property to <see cref="F:System.Drawing.Drawing2D.DashCap.Triangle" /> if the <see cref="T:System.Drawing.Pen" /> has its <see cref="P:System.Drawing.Pen.Alignment" /> property set to <see cref="F:System.Drawing.Drawing2D.PenAlignment.Inset" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the cap style used at the end of the dashes that make up dashed lines drawn with this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DashOffset">
<MemberSignature Language="C#" Value="public float DashOffset { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'float'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the distance from the start of a line to the beginning of a dash pattern.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DashPattern">
<MemberSignature Language="C#" Value="public float[] DashPattern { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single[]</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'float []'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Assigning a value other than null to this property will set the <see cref="T:System.Drawing.Drawing2D.DashStyle" /> property for this <see cref="T:System.Drawing.Pen" /> to <see cref="F:System.Drawing.Drawing2D.DashStyle.Custom" />.</para>
<para>The elements in the <paramref name="dashArray" /> array set the length of each dash and space in the dash pattern. The first element sets the length of a dash, the second element sets the length of a space, the third element sets the length of a dash, and so on. Consequently, each element should be a non-zero positive number.</para>
<para>The length of each dash and space in the dash pattern is the product of the element value in the array and the width of the <see cref="T:System.Drawing.Pen" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets an array of custom dashes and spaces.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DashStyle">
<MemberSignature Language="C#" Value="public System.Drawing.Drawing2D.DashStyle DashStyle { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Drawing2D.DashStyle</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Drawing2D.DashStyle'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A value of <see cref="F:System.Drawing.Drawing2D.DashStyle.Custom" /> for this property specifies that a custom pattern of dashes and spaces, defined by the <see cref="P:System.Drawing.Pen.DashPattern" /> property, makes up lines drawn with this <see cref="T:System.Drawing.Pen" />. If the value of this property is <see cref="F:System.Drawing.Drawing2D.DashStyle.Custom" /> and the value of the <see cref="P:System.Drawing.Pen.DashPattern" /> property is null, the pen draws solid lines.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the style used for dashed lines drawn with this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Calling <see cref="M:System.Drawing.Pen.Dispose" /> allows the resources used by this <see cref="T:System.Drawing.Brush" /> to be reallocated for other purposes.</para>
<para>Call <see cref="M:System.Drawing.Pen.Dispose" /> when you are finished using the <see cref="T:System.Drawing.Pen" />. The <see cref="M:System.Drawing.Pen.Dispose" /> method leaves the <see cref="T:System.Drawing.Pen" /> in an unusable state. After calling <see cref="M:System.Drawing.Pen.Dispose" />, you must release all references to the <see cref="T:System.Drawing.Pen" /> so the garbage collector can reclaim the memory that the <see cref="T:System.Drawing.Pen" /> was occupying. For more information, see <format type="text/html"><a href="a17b0066-71c2-4ba4-9822-8e19332fc213">Cleaning Up Unmanaged Resources</a></format> and <format type="text/html"><a href="eb4e1af0-3b48-4fbc-ad4e-fc2f64138bf9">Implementing a Dispose Method</a></format>. </para>
<block subset="none" type="note">
<para>Always call <see cref="M:System.Drawing.Pen.Dispose" /> before you release your last reference to the <see cref="T:System.Drawing.Pen" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.Drawing.Pen" /> object's Finalize method.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Releases all resources used by this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EndCap">
<MemberSignature Language="C#" Value="public System.Drawing.Drawing2D.LineCap EndCap { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Drawing2D.LineCap</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Drawing2D.LineCap'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the cap style used at the end of lines drawn with this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~Pen ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="LineJoin">
<MemberSignature Language="C#" Value="public System.Drawing.Drawing2D.LineJoin LineJoin { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Drawing2D.LineJoin</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Drawing2D.LineJoin'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A line join is the common area that is formed by two lines whose ends meet or overlap. There are three line join styles: miter, bevel, and round. When you specify a line join style for a <see cref="T:System.Drawing.Pen" /> object, that join style will be applied to all the connected lines in any <see cref="T:System.Drawing.Drawing2D.GraphicsPath" /> object drawn using that pen.The following illustration shows the results of the beveled line join example.</para>
<mediaLink>
<image />
</mediaLink>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the join style for the ends of two consecutive lines drawn with this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MiterLimit">
<MemberSignature Language="C#" Value="public float MiterLimit { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'float'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The miter length is the distance from the intersection of the line walls on the inside of the join to the intersection of the line walls outside of the join. The miter length can be large when the angle between two lines is small. The miter limit is the maximum allowed ratio of miter length to stroke width. The default value is 10.0f.</para>
<para>If the miter length of the join of the intersection exceeds the limit of the join, then the join will be beveled to keep it within the limit of the join of the intersection.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the limit of the thickness of the join on a mitered corner.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MultiplyTransform">
<MemberSignature Language="C#" Value="public void MultiplyTransform (System.Drawing.Drawing2D.Matrix matrix);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="matrix" Type="System.Drawing.Drawing2D.Matrix" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method prepends the multiplication matrix specified in the <paramref name="matrix" /> parameter to the transformation matrix for the multiplication operation.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Multiplies the transformation matrix for this <see cref="T:System.Drawing.Pen" /> by the specified <see cref="T:System.Drawing.Drawing2D.Matrix" />.</para>
</summary>
<param name="matrix">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Drawing2D.Matrix" /> object by which to multiply the transformation matrix. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MultiplyTransform">
<MemberSignature Language="C#" Value="public void MultiplyTransform (System.Drawing.Drawing2D.Matrix matrix, System.Drawing.Drawing2D.MatrixOrder order);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="matrix" Type="System.Drawing.Drawing2D.Matrix" />
<Parameter Name="order" Type="System.Drawing.Drawing2D.MatrixOrder" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method uses the <see cref="T:System.Drawing.Drawing2D.MatrixOrder" /> enumeration element (either prepend or append) specified by the <paramref name="order" /> parameter to carry out the multiplication operation.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Multiplies the transformation matrix for this <see cref="T:System.Drawing.Pen" /> by the specified <see cref="T:System.Drawing.Drawing2D.Matrix" /> in the specified order.</para>
</summary>
<param name="matrix">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Drawing2D.Matrix" /> by which to multiply the transformation matrix. </param>
<param name="order">
<attribution license="cc4" from="Microsoft" modified="false" />The order in which to perform the multiplication operation. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PenType">
<MemberSignature Language="C#" Value="public System.Drawing.Drawing2D.PenType PenType { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Drawing2D.PenType</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'Drawing2D.PenType'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Drawing.Pen" /> can draw solid lines, filled lines, or textured lines, depending on the style specified by a member of the <see cref="T:System.Drawing.Drawing2D.PenType" /> enumeration.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the style of lines drawn with this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ResetTransform">
<MemberSignature Language="C#" Value="public void ResetTransform ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Resets the geometric transformation matrix for this <see cref="T:System.Drawing.Pen" /> to identity.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method does not return a value.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RotateTransform">
<MemberSignature Language="C#" Value="public void RotateTransform (float angle);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="angle" Type="System.Single" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Because the shape of a pen is circular, a rotation does not have any visible effect unless the pen is scaled in the x- or y-axis direction.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Rotates the local geometric transformation by the specified angle. This method prepends the rotation to the transformation.</para>
</summary>
<param name="angle">
<attribution license="cc4" from="Microsoft" modified="false" />The angle of rotation. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RotateTransform">
<MemberSignature Language="C#" Value="public void RotateTransform (float angle, System.Drawing.Drawing2D.MatrixOrder order);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="angle" Type="System.Single" />
<Parameter Name="order" Type="System.Drawing.Drawing2D.MatrixOrder" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Because the shape of a pen is circular, a rotation does not have any visible effect unless the pen is scaled in the x- or y-axis direction.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Rotates the local geometric transformation by the specified angle in the specified order.</para>
</summary>
<param name="angle">
<attribution license="cc4" from="Microsoft" modified="false" />The angle of rotation. </param>
<param name="order">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Drawing2D.MatrixOrder" /> that specifies whether to append or prepend the rotation matrix. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ScaleTransform">
<MemberSignature Language="C#" Value="public void ScaleTransform (float sx, float sy);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sx" Type="System.Single" />
<Parameter Name="sy" Type="System.Single" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Scales the local geometric transformation by the specified factors. This method prepends the scaling matrix to the transformation.</para>
</summary>
<param name="sx">
<attribution license="cc4" from="Microsoft" modified="false" />The factor by which to scale the transformation in the x-axis direction. </param>
<param name="sy">
<attribution license="cc4" from="Microsoft" modified="false" />The factor by which to scale the transformation in the y-axis direction. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ScaleTransform">
<MemberSignature Language="C#" Value="public void ScaleTransform (float sx, float sy, System.Drawing.Drawing2D.MatrixOrder order);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sx" Type="System.Single" />
<Parameter Name="sy" Type="System.Single" />
<Parameter Name="order" Type="System.Drawing.Drawing2D.MatrixOrder" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Scales the local geometric transformation by the specified factors in the specified order.</para>
</summary>
<param name="sx">
<attribution license="cc4" from="Microsoft" modified="false" />The factor by which to scale the transformation in the x-axis direction. </param>
<param name="sy">
<attribution license="cc4" from="Microsoft" modified="false" />The factor by which to scale the transformation in the y-axis direction. </param>
<param name="order">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Drawing2D.MatrixOrder" /> that specifies whether to append or prepend the scaling matrix. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SetLineCap">
<MemberSignature Language="C#" Value="public void SetLineCap (System.Drawing.Drawing2D.LineCap startCap, System.Drawing.Drawing2D.LineCap endCap, System.Drawing.Drawing2D.DashCap dashCap);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="startCap" Type="System.Drawing.Drawing2D.LineCap" />
<Parameter Name="endCap" Type="System.Drawing.Drawing2D.LineCap" />
<Parameter Name="dashCap" Type="System.Drawing.Drawing2D.DashCap" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Sets the values that determine the style of cap used to end lines drawn by this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
<param name="startCap">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Drawing2D.LineCap" /> that represents the cap style to use at the beginning of lines drawn with this <see cref="T:System.Drawing.Pen" />. </param>
<param name="endCap">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Drawing2D.LineCap" /> that represents the cap style to use at the end of lines drawn with this <see cref="T:System.Drawing.Pen" />. </param>
<param name="dashCap">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Drawing.Drawing2D.LineCap" /> that represents the cap style to use at the beginning or end of dashed lines drawn with this <see cref="T:System.Drawing.Pen" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartCap">
<MemberSignature Language="C#" Value="public System.Drawing.Drawing2D.LineCap StartCap { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Drawing2D.LineCap</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Drawing2D.LineCap'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the cap style used at the beginning of lines drawn with this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Transform">
<MemberSignature Language="C#" Value="public System.Drawing.Drawing2D.Matrix Transform { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Drawing.Drawing2D.Matrix</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'Drawing2D.Matrix'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This property defines an elliptical shape for the pen tip. This ellipse is obtained from the default circular shape by applying the transformation matrix. Note that the translation portion of the matrix is ignored. Because the matrix returned and by the <see cref="P:System.Drawing.Pen.Transform" /> property is a copy of the pen's geometric transform, you should dispose of the matrix when you no longer need it.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a copy of the geometric transformation for this <see cref="T:System.Drawing.Pen" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TranslateTransform">
<MemberSignature Language="C#" Value="public void TranslateTransform (float dx, float dy);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dx" Type="System.Single" />
<Parameter Name="dy" Type="System.Single" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Translates the local geometric transformation by the specified dimensions. This method prepends the translation to the transformation.</para>
</summary>
<param name="dx">
<attribution license="cc4" from="Microsoft" modified="false" />The value of the translation in x. </param>
<param name="dy">
<attribution license="cc4" from="Microsoft" modified="false" />The value of the translation in y. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TranslateTransform">
<MemberSignature Language="C#" Value="public void TranslateTransform (float dx, float dy, System.Drawing.Drawing2D.MatrixOrder order);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dx" Type="System.Single" />
<Parameter Name="dy" Type="System.Single" />
<Parameter Name="order" Type="System.Drawing.Drawing2D.MatrixOrder" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Translates the local geometric transformation by the specified dimensions in the specified order.</para>
</summary>
<param name="dx">
<attribution license="cc4" from="Microsoft" modified="false" />The value of the translation in x. </param>
<param name="dy">
<attribution license="cc4" from="Microsoft" modified="false" />The value of the translation in y. </param>
<param name="order">
<attribution license="cc4" from="Microsoft" modified="false" />The order (prepend or append) in which to apply the translation. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public float Width { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'float'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can access the unit of measure of the <see cref="T:System.Drawing.Graphics" /> object using its <see cref="P:System.Drawing.Graphics.PageUnit" /> property. The unit of measure is typically pixels. A <see cref="P:System.Drawing.Pen.Width" /> of 0 will result in the <see cref="T:System.Drawing.Pen" /> drawing as if the <see cref="P:System.Drawing.Pen.Width" /> were 1.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the width of this <see cref="T:System.Drawing.Pen" />, in units of the <see cref="T:System.Drawing.Graphics" /> object used for drawing.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>