TextElement.TextEffects Property

Definition

Namespace:

System.Windows.Documents

Assembly:

PresentationFramework.dll

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

public:
 property System::Windows::Media::TextEffectCollection ^ TextEffects { System::Windows::Media::TextEffectCollection ^ get(); void set(System::Windows::Media::TextEffectCollection ^ value); };

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

member this.TextEffects : System.Windows.Media.TextEffectCollection with get, set

Public Property TextEffects As TextEffectCollection

Property Value

TextEffectCollection

A collection of text effects to apply to the content in this element. The default is null (not an empty collection).

Examples

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();
flickerRun.TextEffects.Add(tfe);

' Create and configure a simple color animation sequence.  Timespan is in 100ns ticks.
Dim blackToWhite As 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.
Dim scb As New SolidColorBrush(Colors.Black)
scb.BeginAnimation(SolidColorBrush.ColorProperty, blackToWhite)

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

' Create a new text run, and add the previously created text effect to the run's effects collection.
Dim flickerRun As New Run("Text that flickers...")
flickerRun.TextEffects = New TextEffectCollection()
flickerRun.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

Identifier field	TextEffectsProperty
Metadata properties set to true	AffectsRender