Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

Stars 159
Forks 14
PowerShell Gallery downloads 158,661
Release v3.0.5
Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Add-OfficeWordText

Aliases: WordBold, WordItalic, WordText
Namespace PSWriteOffice
Aliases
WordBold WordItalic WordText
Inputs
OfficeIMO.Word.WordParagraph
Outputs
OfficeIMO.Word.WordParagraph

Adds inline text to the current paragraph.

Remarks

Supports bold/italic/underline and color tweaks for quick DSL composition.

Examples

Authored help example

Append bold text.

PS>


Add-OfficeWordParagraph { Add-OfficeWordText -Text 'Important: ' -Bold }
        

Writes “Important:” with bold formatting.

Append several styled segments to a paragraph.

PS>


$paragraph | Add-OfficeWordText -Run @{ Text = 'Status: ', 'Ready'; Bold = $true, $false; Color = $null, 'SeaGreen' }
        

Appends one line with independent formatting for its label and value.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Add-OfficeWordText [-Bold] [-Color <String>] [-FontName <String>] [-FontSize <Int32>] [-Italic] [-Paragraph <WordParagraph>] [-PassThru] [-Strike] -Text <String[]> [-Underline <Single>] [<CommonParameters>]
#
Parameter set: Text

Parameters

Bold SwitchParameter optionalposition: namedpipeline: False
Apply bold formatting.
Color String optionalposition: namedpipeline: False
Run color. Named colors and hexadecimal values are accepted.
FontName String optionalposition: namedpipeline: Falsealiases: Font, FontFamily, Typeface
Font name or family.
FontSize Int32 optionalposition: namedpipeline: False
Font size in points.
Italic SwitchParameter optionalposition: namedpipeline: False
Apply italic formatting.
Paragraph WordParagraph optionalposition: namedpipeline: True (ByValue)
Paragraph that will receive the text outside a DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the target paragraph for further composition.
Strike SwitchParameter optionalposition: namedpipeline: False
Render text with strikethrough.
Text String[] requiredposition: 0pipeline: False
Text segments to append.
Underline WordUnderlineStyle optionalposition: namedpipeline: Falsevalues: 17
Optional underline style.
Possible values: Single, Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble

Outputs

OfficeIMO.Word.WordParagraph

Add-OfficeWordText [-Bold] [-Color <String>] [-FontName <String>] [-FontSize <Int32>] [-Italic] [-Paragraph <WordParagraph>] [-PassThru] -Run <Object[]> [-Strike] [-Underline <Single>] [<CommonParameters>]
#
Parameter set: Run

Parameters

Bold SwitchParameter optionalposition: namedpipeline: False
Apply bold formatting.
Color String optionalposition: namedpipeline: False
Run color. Named colors and hexadecimal values are accepted.
FontName String optionalposition: namedpipeline: Falsealiases: Font, FontFamily, Typeface
Font name or family.
FontSize Int32 optionalposition: namedpipeline: False
Font size in points.
Italic SwitchParameter optionalposition: namedpipeline: False
Apply italic formatting.
Paragraph WordParagraph optionalposition: namedpipeline: True (ByValue)
Paragraph that will receive the text outside a DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the target paragraph for further composition.
Run Object[] requiredposition: namedpipeline: Falsealiases: Runs
Rich text runs. Each run can be created with TextRun/WordTextRun or provided as a hashtable/object.
Strike SwitchParameter optionalposition: namedpipeline: False
Render text with strikethrough.
Underline WordUnderlineStyle optionalposition: namedpipeline: Falsevalues: 17
Optional underline style.
Possible values: Single, Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble

Outputs

OfficeIMO.Word.WordParagraph