TextBlock.TextEffects Property

Definition

Namespace:

System.Windows.Controls

Assembly:

PresentationFramework.dll

Gets or sets the effects to apply to the text content in this element.

C#

public System.Windows.Media.TextEffectCollection TextEffects { get; set; }

Property Value

TextEffectCollection

A TextEffectCollection containing one or more TextEffect objects that define effects to apply to the text of the TextBlock. The default is null (no effects applied).

Examples

The following example shows how to create a simple text effect and apply it to a text of a TextBlock.

C#

// 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 TextBlock with some text.
TextBlock textBlock = new TextBlock();
textBlock.Text = "Text that flickers...";

// The TextEffects property is null (no collection) by default.  Create a new one.
textBlock.TextEffects = new TextEffectCollection();

// Add the previously created effect to the TextEffects collection.
textBlock.TextEffects.Add(tfe);

Remarks

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.

Dependency Property Information

Item	Value
Identifier field	TextEffectsProperty
Metadata properties set to true	AffectsRender

Applies to