Pen Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Defines an object used to draw lines and curves. This class cannot be inherited.

Namespace:   System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)


Public NotInheritable Class Pen
	Inherits MarshalByRefObject
	Implements ICloneable, IDisposable

NameDescription
System_CAPS_pubmethodPen(Brush)

Initializes a new instance of the Pen class with the specified Brush.

System_CAPS_pubmethodPen(Brush, Single)

Initializes a new instance of the Pen class with the specified Brush and Width.

System_CAPS_pubmethodPen(Color)

Initializes a new instance of the Pen class with the specified color.

System_CAPS_pubmethodPen(Color, Single)

Initializes a new instance of the Pen class with the specified Color and Width properties.

NameDescription
System_CAPS_pubpropertyAlignment

Gets or sets the alignment for this Pen.

System_CAPS_pubpropertyBrush

Gets or sets the Brush that determines attributes of this Pen.

System_CAPS_pubpropertyColor

Gets or sets the color of this Pen.

System_CAPS_pubpropertyCompoundArray

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.

System_CAPS_pubpropertyCustomEndCap

Gets or sets a custom cap to use at the end of lines drawn with this Pen.

System_CAPS_pubpropertyCustomStartCap

Gets or sets a custom cap to use at the beginning of lines drawn with this Pen.

System_CAPS_pubpropertyDashCap

Gets or sets the cap style used at the end of the dashes that make up dashed lines drawn with this Pen.

System_CAPS_pubpropertyDashOffset

Gets or sets the distance from the start of a line to the beginning of a dash pattern.

System_CAPS_pubpropertyDashPattern

Gets or sets an array of custom dashes and spaces.

System_CAPS_pubpropertyDashStyle

Gets or sets the style used for dashed lines drawn with this Pen.

System_CAPS_pubpropertyEndCap

Gets or sets the cap style used at the end of lines drawn with this Pen.

System_CAPS_pubpropertyLineJoin

Gets or sets the join style for the ends of two consecutive lines drawn with this Pen.

System_CAPS_pubpropertyMiterLimit

Gets or sets the limit of the thickness of the join on a mitered corner.

System_CAPS_pubpropertyPenType

Gets the style of lines drawn with this Pen.

System_CAPS_pubpropertyStartCap

Gets or sets the cap style used at the beginning of lines drawn with this Pen.

System_CAPS_pubpropertyTransform

Gets or sets a copy of the geometric transformation for this Pen.

System_CAPS_pubpropertyWidth

Gets or sets the width of this Pen, in units of the Graphics object used for drawing.

NameDescription
System_CAPS_pubmethodClone()

Creates an exact copy of this Pen.

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by this Pen.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Overrides Object.Finalize().)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodMultiplyTransform(Matrix)

Multiplies the transformation matrix for this Pen by the specified Matrix.

System_CAPS_pubmethodMultiplyTransform(Matrix, MatrixOrder)

Multiplies the transformation matrix for this Pen by the specified Matrix in the specified order.

System_CAPS_pubmethodResetTransform()

Resets the geometric transformation matrix for this Pen to identity.

System_CAPS_pubmethodRotateTransform(Single)

Rotates the local geometric transformation by the specified angle. This method prepends the rotation to the transformation.

System_CAPS_pubmethodRotateTransform(Single, MatrixOrder)

Rotates the local geometric transformation by the specified angle in the specified order.

System_CAPS_pubmethodScaleTransform(Single, Single)

Scales the local geometric transformation by the specified factors. This method prepends the scaling matrix to the transformation.

System_CAPS_pubmethodScaleTransform(Single, Single, MatrixOrder)

Scales the local geometric transformation by the specified factors in the specified order.

System_CAPS_pubmethodSetLineCap(LineCap, LineCap, DashCap)

Sets the values that determine the style of cap used to end lines drawn by this Pen.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodTranslateTransform(Single, Single)

Translates the local geometric transformation by the specified dimensions. This method prepends the translation to the transformation.

System_CAPS_pubmethodTranslateTransform(Single, Single, MatrixOrder)

Translates the local geometric transformation by the specified dimensions in the specified order.

A Pen draws a line of specified width and style. Use the DashStyle property to draw several varieties of dashed lines. The line drawn by a 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.

The following code example demonstrates constructing a Pen with a Brush and the effects of setting the LineJoin property on a Pen.

This example is designed to be used with Windows Forms. Paste the code into a form and call the ShowLineJoin method when handling the form's Paint event, passing e as PaintEventArgs.

Private Sub ShowLineJoin(ByVal e As PaintEventArgs)

    ' Create a new pen.
    Dim skyBluePen As New Pen(Brushes.DeepSkyBlue)

    ' Set the pen's width.
    skyBluePen.Width = 8.0F

    ' Set the LineJoin property.
    skyBluePen.LineJoin = Drawing2D.LineJoin.Bevel

    ' Draw a rectangle.
    e.Graphics.DrawRectangle(skyBluePen, _
        New Rectangle(40, 40, 150, 200))

    'Dispose of the pen.
    skyBluePen.Dispose()

End Sub

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: