ShapeField.GetBackgroundBrush(DiagramClientView, ShapeElement, Color) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Modeling.Diagrams

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.15.0.dll

Assembly:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.dll

Package:: Microsoft.VisualStudio.Modeling.Sdk.Diagrams v17.10.40171

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the background brush to draw with for the specified ShapeElement instance.

public:
 virtual System::Drawing::Brush ^ GetBackgroundBrush(Microsoft::VisualStudio::Modeling::Diagrams::DiagramClientView ^ view, Microsoft::VisualStudio::Modeling::Diagrams::ShapeElement ^ parentShape, System::Drawing::Color % oldColor);

public virtual System.Drawing.Brush GetBackgroundBrush (Microsoft.VisualStudio.Modeling.Diagrams.DiagramClientView view, Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement parentShape, ref System.Drawing.Color oldColor);

abstract member GetBackgroundBrush : Microsoft.VisualStudio.Modeling.Diagrams.DiagramClientView * Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement * Color -> System.Drawing.Brush
override this.GetBackgroundBrush : Microsoft.VisualStudio.Modeling.Diagrams.DiagramClientView * Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement * Color -> System.Drawing.Brush

Public Overridable Function GetBackgroundBrush (view As DiagramClientView, parentShape As ShapeElement, ByRef oldColor As Color) As Brush

Parameters

view: DiagramClientView

Current view to check for highlighting list. This may be null.

parentShape: ShapeElement

The ShapeElement on which to draw.

oldColor: Color

Returns

Brush

The background brush to draw with for the specified ShapeElement instance.

Remarks

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.

Applies to

Compartir a través de