TextField.GetStringFormat Method

Gets the string format to draw the text with for the specified ShapeElement instance.

Namespace:  Microsoft.VisualStudio.Modeling.Diagrams
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0.dll)

Syntax

'Declaration
Public Overridable Function GetStringFormat ( _
    parentShape As ShapeElement _
) As StringFormat

public virtual StringFormat GetStringFormat(
    ShapeElement parentShape
)

public:
virtual StringFormat^ GetStringFormat(
    ShapeElement^ parentShape
)

abstract GetStringFormat : 
        parentShape:ShapeElement -> StringFormat  
override GetStringFormat : 
        parentShape:ShapeElement -> StringFormat

public function GetStringFormat(
    parentShape : ShapeElement
) : StringFormat

Parameters

• parentShape
  Type: Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement

  The ShapeElement on which to draw.

Return Value

Type: System.Drawing.StringFormat

Remarks

By default, this method returns the default string format of this ShapeField. To dynamically change the string format for this ShapeField, override this method.

.NET Framework Security

• 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.

See Also

Reference

TextField Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace