TextFormattingRunProperties.SetTextDecorations Method

Definition

Gets a new TextFormattingRunProperties with the properties of this one but with the text decorations set to textDecorations.

public:
 Microsoft::VisualStudio::Text::Formatting::TextFormattingRunProperties ^ SetTextDecorations(System::Windows::TextDecorationCollection ^ textDecorations);
public Microsoft.VisualStudio.Text.Formatting.TextFormattingRunProperties SetTextDecorations (System.Windows.TextDecorationCollection textDecorations);
member this.SetTextDecorations : System.Windows.TextDecorationCollection -> Microsoft.VisualStudio.Text.Formatting.TextFormattingRunProperties
Public Function SetTextDecorations (textDecorations As TextDecorationCollection) As TextFormattingRunProperties

Parameters

textDecorations
TextDecorationCollection

The new text decoration collection.

Returns

The TextFormattingRunProperties.

Exceptions

textDecorations is null.

Remarks

The textDecorations is frozen by this method.

Applies to