PenSettings Class

Article
04/26/2013

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
	PenSettings	Default constructor.

Top

Properties

	Name	Description
	Alignment	Gets or sets the PenAlignment information. Only allows the change if the property is not immutable and sets the override flags appropriately.
	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.
	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.
	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.
	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.
	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.
	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.
	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.
	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.
	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.
	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.
	ImmutableAlignment	Makes the Alignment setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableBrush	Makes the Brush setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableColor	Makes the Color setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableCompoundArray	Makes the CompoundArray setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableCustomEndCap	Makes the CustomEndCap setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableCustomStartCap	Makes the CustomStartCap setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableDashCap	Makes the DashCap setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableDashOffset	Makes the DashOffset setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableDashPattern	Makes the DashPattern setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableDashStyle	Makes the DashStyle setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableEndCap	Makes the EndCap setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableLineJoin	Makes the LineJoin setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableMiterLimit	Makes the MiterLimit setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableStartCap	Makes the StartCap setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableTransform	Makes the Transform setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	ImmutableWidth	Makes the Width setting immutable, unchangeable by others. Once it's make immutable, no one else can change it.
	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.
	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.
	PenSettingsFlags	Gets the overridden properties in the PenStyleSetInfo.
	PenStyleSetInfo	Gets or sets the PenStyleSetInfo associated with these settings.
	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.
	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.
	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
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsOverridden	Tests whether certain PenSettings are overridden.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	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.

Share via