ShapeField.GetPen Method (DiagramClientView, ShapeElement, Color)

 

Gets the pen that draws the shape element to which the shape field is assigned.

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

public virtual Pen GetPen(
	DiagramClientView view,
	ShapeElement parentShape,
	ref Color oldColor
)

Parameters

view
Type: Microsoft.VisualStudio.Modeling.Diagrams.DiagramClientView

The diagram client view.

parentShape
Type: Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement

The shape element to which the shape field is assigned.

oldColor
Type: System.Drawing.Color

The color of the pen that is being used for the shape field.

Return Value

Type: System.Drawing.Pen

The pen that draws the shape element to which the shape field is assigned.

By default, this method returns the default pen of this ShapeField. To dynamically change the pen for this ShapeField, consider overriding GetPenId first. If that method is inadequate, override this method.

Return to top
Show: