TextBlock.TextEffects Property (System.Windows.Controls)

TextEffects Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework 3.0

.NET Framework Class Library

TextBlock..::.TextEffects Property

Updated: November 2007

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/xaml/presentation

Syntax

Visual Basic (Declaration)

Public Property TextEffects As TextEffectCollection

Visual Basic (Usage)

Dim instance As TextBlock
Dim value As TextEffectCollection

value = instance.TextEffects

instance.TextEffects = value

public TextEffectCollection TextEffects { get; set; }

Visual C++

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

/** @property */
public TextEffectCollection get_TextEffects()
/** @property */
public  void set_TextEffects(TextEffectCollection value)

JScript

public function get TextEffects () : TextEffectCollection
public function set TextEffects (value : TextEffectCollection)

XAML Property Element Usage

<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 nullNothingnullptra null reference (Nothing in Visual Basic) (no effects applied).

Dependency Property Information

Identifier field	TextEffectsProperty
Metadata properties set to true	AffectsRender

Remarks

By default, this property is set to nullNothingnullptra null reference (Nothing in Visual Basic) and has no TextEffectCollection associated with it. Before adding any text effects, create a new TextEffectCollection and assign it to this property.

Examples

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

Platforms

Windows Vista

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.

Version Information