Cmdlet

Add-OfficeWordText

Aliases: WordBold, WordItalic, WordText

Module: PSWriteOffice
Aliases: WordBold WordItalic WordText
Inputs: OfficeIMO.Word.WordParagraph
Outputs: OfficeIMO.Word.WordParagraph
Source: AddOfficeWordTextCommand.cs:25 Edit on GitHub

Adds inline text to the current paragraph.

Syntax

Add-OfficeWordText
[-Bold]
[-Color <String>]
[-FontName <String>]
[-FontSize <Double>]
[-Italic]
[-Paragraph <WordParagraph>]
[-PassThru]
[-Strike]
[-Text] <String[]>
[-Underline <WordUnderlineStyle>]
[<CommonParameters>]

Parameter set: Text

Add-OfficeWordText
[-Bold]
[-Color <String>]
[-FontName <String>]
[-FontSize <Double>]
[-Italic]
[-Paragraph <WordParagraph>]
[-PassThru]
-Run <Object[]>
[-Strike]
[-Underline <WordUnderlineStyle>]
[<CommonParameters>]

Parameter set: Run

Description

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

Examples

Append bold text.

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

Writes “Important:” with bold formatting.

Append several styled segments to a paragraph.

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

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

Parameters

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

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.