TextEffects Property

TextElement.TextEffects Property


Gets or sets a collection of text effects to apply to the content of the element.

Namespace:   System.Windows.Documents
Assembly:  PresentationFramework (in PresentationFramework.dll)

public TextEffectCollection TextEffects { get; set; }

Property Value

Type: System.Windows.Media.TextEffectCollection

A TextEffectCollection containing one or more TextEffect objects that define effects to apply to the content in this element. The default is null (not an empty collection).

By default, this property is set to null and has no TextEffectCollection associated with it. Before adding any text effects, create a new TextEffectCollection and assign it to this property.

Identifier field


Metadata properties set to true


The following example shows how to create a simple text effect and apply it to a text Run through the TextEffects property.

// Create and configure a simple color animation sequence.  Timespan is in 100ns ticks.
ColorAnimation blackToWhite = new ColorAnimation(Colors.White, Colors.Black, new Duration(new TimeSpan(100000)));
blackToWhite.AutoReverse = true;
blackToWhite.RepeatBehavior = RepeatBehavior.Forever;

// Create a new brush and apply the color animation.
SolidColorBrush scb = new SolidColorBrush(Colors.Black);
scb.BeginAnimation(SolidColorBrush.ColorProperty, blackToWhite);

// Create a new TextEffect object; set foreground brush to the previously created brush.
TextEffect tfe = new TextEffect();
tfe.Foreground = scb;
// Range of text to apply effect to (all).
tfe.PositionStart = 0;
tfe.PositionCount = int.MaxValue;

// Create a new text run, and add the previously created text effect to the run's effects collection.
Run flickerRun = new Run("Text that flickers...");
flickerRun.TextEffects = new TextEffectCollection();

.NET Framework
Available since 3.0
Return to top
© 2015 Microsoft