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

Syntax

'宣言
Public Overridable Function GetBackgroundBrush ( _
    view As DiagramClientView, _
    parentShape As ShapeElement, _
    ByRef oldColor As Color _
) As Brush
'使用
Dim instance As ShapeField
Dim view As DiagramClientView
Dim parentShape As ShapeElement
Dim oldColor As Color
Dim returnValue As Brush

returnValue = instance.GetBackgroundBrush(view, _
    parentShape, oldColor)

public virtual Brush GetBackgroundBrush(
    DiagramClientView view,
    ShapeElement parentShape,
    ref Color oldColor
)

public:
virtual Brush^ GetBackgroundBrush(
    DiagramClientView^ view, 
    ShapeElement^ parentShape, 
    Color% oldColor
)

public function GetBackgroundBrush(
    view : DiagramClientView, 
    parentShape : ShapeElement, 
    oldColor : Color
) : Brush

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.

Remarks

You can also use GetBackgroundBrushId to change the background brush for the shape field.

Permissions

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.