ShapeField::GetBackgroundBrush Method (DiagramClientView^, ShapeElement^, Color)

 

Gets the brush that draws the background for the shape element to which this 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 Brush^ GetBackgroundBrush(
	DiagramClientView^ view,
	ShapeElement^ parentShape,
	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 current color of the shape field.

Return Value

Type: System.Drawing::Brush^

The brush that draws the background for the shape element to which this shape field is assigned.

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

Return to top
Show: