Class TextEffect

Represents the text effects applied to an object or text, such as shadow, outline, glow, reflection, 3D effect, or gradient.

Inheritance
System.Object
TextEffect
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class TextEffect : Object

TextEffect gathers the visual effects you can layer onto text, so glow, gradient fill, shadow, reflection, a 3-D bevel, and an outline all hang off one object instead of being scattered across the styling API. You build it up by assigning the individual effects you want, then attach the whole bundle to a run's style.

A TextEffect reaches text through TextStyle, which exposes a TextEffect property. Assign your configured effect there and every run carrying that style picks up the look. Because the effects live together on a single object, you can prepare one decorative treatment once and reuse it across headings or callouts without rebuilding each effect inline.

Each property maps to a dedicated effect type. GlowEffect takes a Glow, GradientEffect takes a Gradient, Effect3D takes an Effect3D, and TextOutlineEffect takes a TextOutlineEffect, while ShadowEffect and ReflectionEffect cover drop shadows and mirrored reflections beneath the text. Set only the effects a design calls for and leave the rest unassigned, since an unset property simply contributes nothing to the rendered look. The properties combine rather than replace one another, so a single heading can carry a gradient fill, a soft glow, and an outline at the same time without any of them canceling the others. Build each sub-effect first, configure its own settings, assign it to the matching property on the TextEffect, and then hand the whole bundle to a TextStyle so the run renders with the full treatment when the document is saved.

using IronWord.Models;

var effect = new TextEffect();
effect.GlowEffect = new Glow();
effect.TextOutlineEffect = TextOutlineEffect.DefaultEffect;

The glow effect how-to adds a glow, the gradient effect how-to fills text with a gradient, and the text outline how-to outlines characters.

Constructors

TextEffect()

Declaration
public TextEffect()

Properties

Effect3D

Gets or sets the 3D effect applied to the text.

Declaration
public Effect3D Effect3D { get; set; }
Property Value
Type Description
Effect3D

GlowEffect

Gets or sets the glow effect applied to the text.

Declaration
public Glow GlowEffect { get; set; }
Property Value
Type Description
Glow

GradientEffect

Gets or sets the gradient effect applied to the text.

Declaration
public Gradient GradientEffect { get; set; }
Property Value
Type Description
Gradient

ReflectionEffect

Gets or sets the reflection effect applied to the text.

Declaration
public Reflection ReflectionEffect { get; set; }
Property Value
Type Description
Reflection

ShadowEffect

Gets or sets the shadow effect applied to the text.

Declaration
public Shadow ShadowEffect { get; set; }
Property Value
Type Description
Shadow

TextOutlineEffect

Gets or sets the text outline effect applied to the text.

Declaration
public TextOutlineEffect TextOutlineEffect { get; set; }
Property Value
Type Description
TextOutlineEffect