How to Add a Text Outline Effect in C#

Why Should I Use TextOutlineEffect for Text Styling?

To apply a text outline effect, create a TextStyle and populate its TextEffect property with a TextOutlineEffect. Then create a Paragraph, followed by a Run containing TextContent. Assign the TextStyle to the Run (not the TextContent), then use AddChild to add the Run to the Paragraph. This follows the document hierarchy: Document → Paragraph → Run → TextContent.

The TextOutlineEffect class provides a comprehensive API for controlling every aspect of your text outlines. Unlike basic text formatting options, it offers granular control over outline properties such as line width, color, pen alignment, and dash patterns. This level of control is essential when creating professional documents that need to meet specific branding guidelines or accessibility requirements.

For business applications, text outlines can significantly improve document readability when printing on various paper stocks or when documents will be viewed on different devices. The outline creates a buffer zone around each character, ensuring text remains legible even against busy backgrounds or low-contrast scenarios.

What's the Basic Code Pattern for Adding Outlines?

:path=/static-assets/word/content-code-examples/how-to/text-effect-text-outline-effect.cs

using IronWord;
using IronWord.Models;

// Create new Word document
WordDocument doc = new WordDocument();

// Create and configure text style
TextStyle textStyle = new TextStyle();
textStyle.TextEffect = new TextEffect()
{
    TextOutlineEffect = TextOutlineEffect.DefaultEffect,
};

// Create paragraph
Paragraph paragraph = new Paragraph();

// Create run with text and style
Run textRun = new Run(new TextContent("Hello World"));
textRun.Style = textStyle;

// Add run to paragraph
paragraph.AddChild(textRun);

// Add paragraph to document
doc.AddParagraph(paragraph);

// Export new Word document
doc.SaveAs("textOutlineEffect.docx");

Imports IronWord
Imports IronWord.Models

' Create new Word document
Dim doc As New WordDocument()

' Create and configure text style
Dim textStyle As New TextStyle()
textStyle.TextEffect = New TextEffect() With {
    .TextOutlineEffect = TextOutlineEffect.DefaultEffect
}

' Create paragraph
Dim paragraph As New Paragraph()

' Create run with text and style
Dim textRun As New Run(New TextContent("Hello World"))
textRun.Style = textStyle

' Add run to paragraph
paragraph.AddChild(textRun)

' Add paragraph to document
doc.AddParagraph(paragraph)

' Export new Word document
doc.SaveAs("textOutlineEffect.docx")

This basic pattern demonstrates the fundamental approach to applying text outlines. The code creates a new document, defines a text style with the default outline effect, applies it to text, and saves the result. The DefaultEffect provides a balanced outline that works well for most scenarios, featuring a subtle width and complementary color that enhances rather than overwhelms the text.

What Properties Control the Outline Appearance?

The text outline effect offers a variety of customizable properties to suit any design need. Understanding these properties enables you to create outlines that perfectly match your document's visual requirements and brand guidelines. Below are the properties along with their descriptions:

Each property serves a specific purpose in creating professional-looking text outlines. For instance, LineWidth directly impacts visual prominence – thinner outlines (0.1-0.3 points) create subtle emphasis, while thicker outlines (1.0-2.0 points) make bold statements. The Color property is crucial for maintaining brand consistency and ensuring adequate contrast for accessibility.

How Do I Apply Custom Outline Properties?

:path=/static-assets/word/content-code-examples/how-to/text-effect-customized-text-outline-effect.cs

using IronWord;
using IronWord.Models;
using IronWord.Models.Enums;

// Create new Word document
WordDocument doc = new WordDocument();

// Create and configure text style
TextStyle textStyle = new TextStyle();
textStyle.TextEffect = new TextEffect()
{
    TextOutlineEffect = new TextOutlineEffect()
    {
        Color = IronWord.Models.Color.Red,
        CompoundLineType = CompoundLineValues.Double,
        LineCapType = LineCapValues.Round,
        LineJoin = StrokeJoinStyleValues.Bevel,
        LineWidth = 0.3,
        PenAlignment = PenAlignmentValues.Center,
        presetLineDash = PresetLineDashValues.Solid
    },
};

// Create paragraph
Paragraph paragraph = new Paragraph();

// Create run with text and style
Run textRun = new Run(new TextContent("Customized text outline"));
textRun.Style = textStyle;

// Add run to paragraph
paragraph.AddChild(textRun);

// Add paragraph to document
doc.AddParagraph(paragraph);

// Export new Word document
doc.SaveAs("customizedTextOutlineEffect.docx");

Imports IronWord
Imports IronWord.Models
Imports IronWord.Models.Enums

' Create new Word document
Dim doc As New WordDocument()

' Create and configure text style
Dim textStyle As New TextStyle()
textStyle.TextEffect = New TextEffect() With {
    .TextOutlineEffect = New TextOutlineEffect() With {
        .Color = IronWord.Models.Color.Red,
        .CompoundLineType = CompoundLineValues.Double,
        .LineCapType = LineCapValues.Round,
        .LineJoin = StrokeJoinStyleValues.Bevel,
        .LineWidth = 0.3,
        .PenAlignment = PenAlignmentValues.Center,
        .presetLineDash = PresetLineDashValues.Solid
    }
}

' Create paragraph
Dim paragraph As New Paragraph()

' Create run with text and style
Dim textRun As New Run(New TextContent("Customized text outline"))
textRun.Style = textStyle

' Add run to paragraph
paragraph.AddChild(textRun)

' Add paragraph to document
doc.AddParagraph(paragraph)

' Export new Word document
doc.SaveAs("customizedTextOutlineEffect.docx")

This advanced example showcases the full power of custom outline configuration. The code creates a distinctive red outline with a double line style, demonstrating how multiple properties work together to achieve specific visual effects. The round line caps and bevel joins create smooth, professional-looking outlines that work well for headers and titles.

When implementing custom outlines in production applications, consider creating reusable style templates. Define standard outline configurations for different document elements (headers, subheaders, emphasis text) and store them as constants or configuration settings. This approach ensures consistency across your document generation pipeline and simplifies maintenance when brand guidelines change.

For optimal results, test your outline effects across different output formats and viewing conditions. What looks good on screen might need adjustment for print output. Consider factors like printer resolution, paper color, and viewing distance when selecting outline widths and colors. The flexibility of IronWord's TextOutlineEffect class allows you to fine-tune these parameters programmatically based on output requirements.