TextElement.TextEffects Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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 Property TextEffects As TextEffectCollection

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

TextEffectsProperty

Metadata properties set to true

AffectsRender

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.
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)

.NET Framework
Available since 3.0
Return to top
Show: