TextField.GetStringFormat(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 string format to draw the text with for the specified ShapeElement instance.

public:
 virtual System::Drawing::StringFormat ^ GetStringFormat(Microsoft::VisualStudio::Modeling::Diagrams::ShapeElement ^ parentShape);

public virtual System.Drawing.StringFormat GetStringFormat (Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement parentShape);

abstract member GetStringFormat : Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement -> System.Drawing.StringFormat
override this.GetStringFormat : Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement -> System.Drawing.StringFormat

Public Overridable Function GetStringFormat (parentShape As ShapeElement) As StringFormat

Parameters

parentShape: ShapeElement

The ShapeElement on which to draw.

Returns

StringFormat

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

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.

Applies to