Where does TextOutlineEffect live in the IronWord API?

TextOutlineEffect is a class in the IronWord.Models namespace, shipped in IronWord.dll, with Object as its base type. It is assigned to the TextOutlineEffect property on a TextEffect, which carries the outline onto a styled text run.

How do you outline text in a C# Word document?

Start from TextOutlineEffect.DefaultEffect, set the stroke Color and width through LineWidth or SetLineWidth, then assign the effect to a TextEffect and apply that through a TextStyle. The outline renders around each character.

How do you set the outline thickness in specific units?

Call SetLineWidth with a value and a MeasurementUnit to specify the stroke width, and GetLineWidth to read it back in the same units. The plain LineWidth property holds the raw value when units are not a concern.

Class TextOutlineEffect

Represents the outline effect applied to text in a Word document.

Inheritance

System.Object

TextOutlineEffect

Namespace: IronWord.Models

Assembly: IronWord.dll

Syntax

public class TextOutlineEffect : Object

An outlined character, where the stroke around each letter is colored and weighted independently of the fill, comes from TextOutlineEffect. You configure the outline's color, thickness, dash pattern, and corner treatment, then apply it so headings and display text read as drawn shapes rather than flat type.

The effect attaches to text through TextEffect, which exposes a TextOutlineEffect property. Assign a configured instance there and the style that owns the TextEffect carries the outline onto every run it formats. A static DefaultEffect returns a ready-made outline, so you can start from a sensible baseline and adjust only the parts you care about.

Set the stroke color with Color and its thickness with LineWidth, or use SetLineWidth to supply the width in a chosen MeasurementUnit and GetLineWidth to read it back in the same units, which keeps the measurement explicit when a design specifies points or millimeters. The line's shape is controlled by CompoundLineType (a CompoundLineValues for single or doubled strokes), LineCapType and LineJoin for how the ends and corners are drawn, PenAlignment (a PenAlignmentValues) for how the stroke sits on the glyph edge, and presetLineDash for a dashed pattern instead of a solid rule. Configure the values a design needs, leave the rest at their defaults from DefaultEffect, and assign the result to a TextEffect before saving so the outline renders on screen and in the exported document.

using IronWord.Models;

var outline = TextOutlineEffect.DefaultEffect;
outline.SetLineWidth(1.5, MeasurementUnit.Point);

The text outline how-to outlines characters, the text outline example shows a worked outline in code, and the style text how-to covers the surrounding text formatting.

Constructors

TextOutlineEffect()

Create a TextOutlineEffect instance.

Declaration

public TextOutlineEffect()

Fields

DefaultEffect

Create a predefined outline effect instance.

Declaration

public static TextOutlineEffect DefaultEffect

Field Value

Type	Description
TextOutlineEffect

Properties

Color

Gets or sets the solid fill color for the outline effect.

Declaration

public Color Color { get; set; }

Property Value

Type	Description
Color

CompoundLineType

Gets or sets the type of compound line used for the outline effect.

Declaration

public CompoundLineValues CompoundLineType { get; set; }

Property Value

Type	Description
CompoundLineValues

LineCapType

Gets or sets the type of line cap used for the outline effect.

Declaration

public LineCapValues LineCapType { get; set; }

Property Value

Type	Description
LineCapValues

LineJoin

Gets or sets the stroke join style used for the outline effect.

Declaration

public StrokeJoinStyleValues LineJoin { get; set; }

Property Value

Type	Description
StrokeJoinStyleValues

LineWidth

Gets or sets the width of the outline effect line.

Declaration

public double LineWidth { get; set; }

Property Value

Type	Description
System.Double

Remarks

The width is specified in points (1/72 inch).

PenAlignment

Gets or sets the alignment of the pen used for the outline effect.

Declaration

public PenAlignmentValues PenAlignment { get; set; }

Property Value

Type	Description
PenAlignmentValues

presetLineDash

Gets or sets the preset line dash style for the outline effect.

Declaration

public PresetLineDashValues presetLineDash { get; set; }

Property Value

Type	Description
PresetLineDashValues

Methods

GetLineWidth(MeasurementUnit)

Gets the width of the outline effect line in the specified measurement unit.

Declaration

public double GetLineWidth(MeasurementUnit measurementUnit)

Parameters

Type	Name	Description
MeasurementUnit	measurementUnit	The measurement unit to convert the width to.

Returns

Type	Description
System.Double	The width of the outline effect line.

SetLineWidth(Double, MeasurementUnit)

Sets the width of the outline effect line to the specified value in the specified measurement unit.

Declaration

public void SetLineWidth(double lineWidth, MeasurementUnit measurementUnit)

Parameters

Type	Name	Description
System.Double	lineWidth	The width of the outline effect line.
MeasurementUnit	measurementUnit	The measurement unit of the specified width.