TextFormattingRunProperties.SetTextEffects(TextEffectCollection) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Text.Formatting

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

Package:: Microsoft.VisualStudio.Text.UI.Wpf v17.9.187

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 effects set to textEffects.

public:
 Microsoft::VisualStudio::Text::Formatting::TextFormattingRunProperties ^ SetTextEffects(System::Windows::Media::TextEffectCollection ^ textEffects);

public Microsoft.VisualStudio.Text.Formatting.TextFormattingRunProperties SetTextEffects (System.Windows.Media.TextEffectCollection textEffects);

member this.SetTextEffects : System.Windows.Media.TextEffectCollection -> Microsoft.VisualStudio.Text.Formatting.TextFormattingRunProperties

Public Function SetTextEffects (textEffects As TextEffectCollection) As TextFormattingRunProperties

Parameters

textEffects: TextEffectCollection

The new text effect collection.

Returns

TextFormattingRunProperties

The TextFormattingRunProperties.

Exceptions

ArgumentNullException

textEffects is null.

Remarks

The textEffects is frozen by this method.

Applies to