Share via


PenSettings Class

PenSettings allows certain properties on a PenStyleSetInfo to be marked as overridden or immutable. If certain Pen settings are marked as immutable, then they are not allowed to be changed again.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Modeling.Diagrams.PenSettings

Namespace:  Microsoft.VisualStudio.Modeling.Diagrams
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0.dll)

Syntax

'Declaration
Public Class PenSettings
public class PenSettings
public ref class PenSettings
type PenSettings =  class end
public class PenSettings

The PenSettings type exposes the following members.

Constructors

  Name Description
Public method PenSettings Default constructor.

Top

Properties

  Name Description
Public property Alignment Gets or sets the PenAlignment information. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property Brush Gets or sets the Brush information for the PenStyleSetInfo. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property Color Gets or sets the Color information for this PenStyleSetInfo. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property CompoundArray Gets or sets an array values that specify a compound pen for the PenStyleSetInfo. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property CustomEndCap Gets or sets a custom cap to use at the end of lines drawn with this Pen object. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property CustomStartCap Gets or sets a custom cap to use at the beginning of lines drawn with this PenStyleSetInfo object. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property DashCap Gets or sets the cap style used at the end of the dashes that make up dashed lines drawn with this PenStyleSetInfo object. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property DashOffset Gets or sets the distance from the start of a line to the beginning of a dash pattern. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property DashPattern Gets or sets an array of custom dashes and spaces. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property DashStyle Gets or sets the style used for dashed lines drawn with this Pen object. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property EndCap Gets or sets the cap style used at the end of lines drawn with this PenStyleSetInfo object. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property ImmutableAlignment Makes the Alignment setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableBrush Makes the Brush setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableColor Makes the Color setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableCompoundArray Makes the CompoundArray setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableCustomEndCap Makes the CustomEndCap setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableCustomStartCap Makes the CustomStartCap setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableDashCap Makes the DashCap setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableDashOffset Makes the DashOffset setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableDashPattern Makes the DashPattern setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableDashStyle Makes the DashStyle setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableEndCap Makes the EndCap setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableLineJoin Makes the LineJoin setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableMiterLimit Makes the MiterLimit setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableStartCap Makes the StartCap setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableTransform Makes the Transform setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property ImmutableWidth Makes the Width setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
Public property LineJoin Gets or sets the join style for the ends of two consecutive lines drawn with this PenStyleSetInfo object. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property MiterLimit Gets or sets the limit of the thickness of the join on a mitered corner. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property PenSettingsFlags Gets the overridden properties in the PenStyleSetInfo.
Public property PenStyleSetInfo Gets or sets the PenStyleSetInfo associated with these settings.
Public property StartCap Gets or sets the cap style used at the beginning of lines drawn with this PenStyleSetInfo object. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property Transform Gets or sets the geometric transformation for this PenStyleSetInfo object. Only allows the change if the property is not immutable and sets the override flags appropriately.
Public property Width Gets or sets the width of this PenStyleSetInfo object. Only allows the change if the property is not immutable and sets the override flags appropriately.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsOverridden Tests whether certain PenSettings are overridden.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Thread Safety

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

See Also

Reference

Microsoft.VisualStudio.Modeling.Diagrams Namespace