TextField.GetTextBrush(DiagramClientView, ShapeElement) 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.40089

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 brush to draw the text with for the specified ShapeElement instance.

public:
 virtual System::Drawing::Brush ^ GetTextBrush(Microsoft::VisualStudio::Modeling::Diagrams::DiagramClientView ^ view, Microsoft::VisualStudio::Modeling::Diagrams::ShapeElement ^ parentShape);

public virtual System.Drawing.Brush GetTextBrush (Microsoft.VisualStudio.Modeling.Diagrams.DiagramClientView view, Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement parentShape);

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

Public Overridable Function GetTextBrush (view As DiagramClientView, parentShape As ShapeElement) As Brush

Parameters

view: DiagramClientView

parentShape: ShapeElement

The ShapeElement on which to draw.

Returns

Brush

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

Remarks

By default, this method returns the default text brush of this ShapeField.

To dynamically change the text brush for this ShapeField, consider overriding GetTextBrushId first. If that method is inadequate, override this method.

Applies to