Freigeben über


ShapeField.GetBackgroundBrush Method

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.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0.dll)

Syntax

'Declaration
Public Overridable Function GetBackgroundBrush ( _
    view As DiagramClientView, _
    parentShape As ShapeElement, _
    ByRef oldColor As Color _
) As Brush
public virtual Brush GetBackgroundBrush(
    DiagramClientView view,
    ShapeElement parentShape,
    ref Color oldColor
)
public:
virtual Brush^ GetBackgroundBrush(
    DiagramClientView^ view, 
    ShapeElement^ parentShape, 
    Color% oldColor
)
abstract GetBackgroundBrush : 
        view:DiagramClientView * 
        parentShape:ShapeElement * 
        oldColor:Color byref -> Brush 
override GetBackgroundBrush : 
        view:DiagramClientView * 
        parentShape:ShapeElement * 
        oldColor:Color byref -> Brush 
public function GetBackgroundBrush(
    view : DiagramClientView, 
    parentShape : ShapeElement, 
    oldColor : Color
) : Brush

Parameters

Return Value

Type: System.Drawing.Brush
The brush that draws the background for the shape element to which this shape field is assigned.

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.

.NET Framework Security

See Also

Reference

ShapeField Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace