Cmdlet

Add-OfficeWordBreak

Aliases: WordBreak

Module PSWriteOffice

Aliases

WordBreak

Inputs

OfficeIMO.Word.WordParagraph

Outputs

OfficeIMO.Word.WordParagraph

Source

AddOfficeWordBreakCommand.cs:19 Edit on GitHub

Adds a break to a Word paragraph.

Syntax

Add-OfficeWordBreak [-BreakType <Page|Column|TextWrapping>] [-Count <Int32>] [-Paragraph <WordParagraph>] [-PassThru] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

By default this creates a soft line break, equivalent to Shift+Enter in Word.

Examples

Authored help example

Add a same-paragraph line break.

Add-OfficeWordParagraph { Add-OfficeWordText 'Line 1'; Add-OfficeWordBreak; Add-OfficeWordText 'Line 2' }

Writes both lines in the same paragraph separated by a soft break.

Parameters

-BreakType WordBreakType optional: Optional break type, for example Page or Column.; Possible values: Page, Column, TextWrapping
-Count Int32 optional: Number of breaks to add.
-Paragraph WordParagraph optionalpipeline: True (ByValue): Target paragraph. When omitted, the current DSL paragraph is used or created.
-PassThru SwitchParameter optional: Emit the paragraph returned by the final break for additional native OfficeIMO chaining.

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.