TextFormattingRunProperties.SetTextDecorations Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Formatting

Assembly:: Microsoft.VisualStudio.Text.UI.Wpf.dll

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

TextFormattingRunProperties

The TextFormattingRunProperties.

Exceptions

ArgumentNullException

textDecorations is null.

Remarks

The textDecorations is frozen by this method.

Applies to