Share via


ShapeField.GetBackgroundBrushId Method

Gets the ID of 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 GetBackgroundBrushId ( _
    view As DiagramClientView, _
    parentShape As ShapeElement _
) As StyleSetResourceId
public virtual StyleSetResourceId GetBackgroundBrushId(
    DiagramClientView view,
    ShapeElement parentShape
)
public:
virtual StyleSetResourceId^ GetBackgroundBrushId(
    DiagramClientView^ view, 
    ShapeElement^ parentShape
)
abstract GetBackgroundBrushId : 
        view:DiagramClientView * 
        parentShape:ShapeElement -> StyleSetResourceId 
override GetBackgroundBrushId : 
        view:DiagramClientView * 
        parentShape:ShapeElement -> StyleSetResourceId 
public function GetBackgroundBrushId(
    view : DiagramClientView, 
    parentShape : ShapeElement
) : StyleSetResourceId

Parameters

Return Value

Type: Microsoft.VisualStudio.Modeling.Diagrams.StyleSetResourceId
The ID of the brush that draws the background for the shape element to which the shape field is assigned.

Remarks

By default, this method returns the default background brush id. To dynamically change the background brush for this ShapeField, override this method.

.NET Framework Security

See Also

Reference

ShapeField Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace