Export (0) Print
Expand All

TextBlock.TextEffects Property

Gets or sets the effects to apply to the text content in this element. This is a dependency property.

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

public TextEffectCollection TextEffects { get; set; }
<object>
  <object.TextEffects>
    <TextEffectCollection .../>
  </object.TextEffects>
</object>

Property Value

Type: System.Windows.Media.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).

Identifier field

TextEffectsProperty

Metadata properties set to true

AffectsRender

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.

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

// 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);

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0

Community Additions

ADD
Show:
© 2014 Microsoft