Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 700 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

Add-OfficeWordText

Aliases: WordText
Module
PSWriteOffice
Aliases
WordText
Inputs
OfficeIMO.Word.WordParagraph
Outputs
OfficeIMO.Word.WordParagraph OfficeIMO.Word.WordHyperLink
Source
AddOfficeWordTextCommand.cs:19 Edit on GitHub

Adds styled text or a hyperlink to the current or given Word paragraph.

Syntax

Add-OfficeWordText
[-BackgroundColor <OfficeColor>]
[-Baseline <Normal|Superscript|Subscript>]
[-Bold]
[-Color <OfficeColor>]
[-Font <String>]
[-Italic]
[-Paragraph <WordParagraph>]
[-PassThru]
[-Size <OfficeLength>]
[-Strikethrough]
[-Text] <String[]>
[-Underline <WordUnderlineStyle>]
[<CommonParameters>]
#
Parameter set: Text
Add-OfficeWordText
[-BackgroundColor <OfficeColor>]
[-Baseline <Normal|Superscript|Subscript>]
[-Bold]
[-Color <OfficeColor>]
[-Font <String>]
[-Italic]
-Link <Uri>
[-NoHistory]
[-NoLinkStyle]
[-Paragraph <WordParagraph>]
[-PassThru]
[-Size <OfficeLength>]
[-Strikethrough]
[-Text] <String[]>
[-Tooltip <String>]
[-Underline <WordUnderlineStyle>]
[<CommonParameters>]
#
Parameter set: Link
Add-OfficeWordText
-Anchor <String>
[-BackgroundColor <OfficeColor>]
[-Baseline <Normal|Superscript|Subscript>]
[-Bold]
[-Color <OfficeColor>]
[-Font <String>]
[-Italic]
[-NoHistory]
[-NoLinkStyle]
[-Paragraph <WordParagraph>]
[-PassThru]
[-Size <OfficeLength>]
[-Strikethrough]
[-Text] <String[]>
[-Tooltip <String>]
[-Underline <WordUnderlineStyle>]
[<CommonParameters>]
#
Parameter set: Anchor

Description

A bare Size means points; unit-suffixed lengths are accepted. Hyperlinks use the Hyperlink style unless NoLinkStyle is supplied.

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • PSWriteOffice DSL Cookbook Guide

    Copy complete PowerShell recipes for Word, Excel, PowerPoint, PDF, Markdown, and multi-format document jobs.

  • Migrate from PSWriteWord to PSWriteOffice Guide

    Replace archived PSWriteWord scripts with maintained PSWriteOffice Word commands for DOCX creation, editing, review, merge, and conversion.

  • Turn Windows event logs into an investigation handoff Guide

    Collect Windows errors with PSEventViewer, explain the snapshot in a Word and PDF brief, and keep the full messages in an editable Excel register.

  • Compare supplier quotes without retyping an HTML table Guide

    Read supplier offers with PSParseHTML, compare price and delivery, and create an editable Word review, PDF and numeric Excel workbook with PSWriteOffice.

  • Readable document layouts Guide

    Build readable PSWriteOffice reports with paragraph spacing, table-cell padding, consistent colours, clear chart units, and page-aware layouts.

  • Quick Start Guide

    Create your first Word document, Excel workbook, and PowerPoint presentation with OfficeIMO in minutes. Includes examples and API links.

  • Project delivery and milestones Sample

    Turn dated milestones into an editable register and a Word/PDF review with completed counts, overdue work and named recovery actions.

  • Budget and forecast review Sample

    Reconcile annual budget, actual spending and forecast in an editable workbook, then produce a Word/PDF review with owner decisions for overspend exceptions.

  • Patch compliance report from PowerShell Sample

    Review patch compliance and site exceptions with a PowerShell report, including a summary chart, an editable Word document and a PDF.

Examples

Append styled text.

WordParagraph { WordText 'Important: ' -Bold -Font Aptos -Size 11pt; WordText 'read first' -Italic }

Add a link and a bookmark reference.

WordParagraph { WordText 'Example' -Link 'https://example.org' -Tooltip 'External reference'; WordText 'Summary' -Anchor Summary }

Parameters

-BackgroundColor OfficeColor optional
Run highlight or shading color; explicit null clears both.
-Baseline OfficeTextBaseline optional
Normal, superscript or subscript baseline.
Possible values: Normal, Superscript, Subscript
-Bold SwitchParameter optional
Apply bold formatting.
-Color OfficeColor optional
Text color, including a semantic theme role.
-Font String optional
Font family.
-Italic SwitchParameter optional
Apply italic formatting.
-Paragraph WordParagraph optionalpipeline: True (ByValue)
Paragraph to receive text outside a content block.
-PassThru SwitchParameter optional
Emit each newly created run, or each hyperlink for Link and Anchor.
-Size OfficeLength optional
Font size; a bare number means points.
-Strikethrough SwitchParameter optional
Apply strikethrough.
-Text String[] requiredposition: 0
Text segments to append.
-Underline WordUnderlineStyle optional
Underline style.
Possible values: Single, Words, Double, Thick, Dotted, DottedHeavy, Dash, DashedHeavy, DashLong, DashLongHeavy, DotDash, DashDotHeavy, DotDotDash, DashDotDotHeavy, Wave, WavyHeavy, WavyDouble
Absolute hyperlink URL.
-NoHistory SwitchParameter optionalsets: Link, Anchor
Disable hyperlink navigation history.
-NoLinkStyle SwitchParameter optionalsets: Link, Anchor
Do not apply the built-in Hyperlink character style.
-Tooltip String optionalsets: Link, Anchor
Hyperlink tooltip.
-Anchor String requiredsets: Anchor
Bookmark target in this document.

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.