Add-OfficeWordBreak

Aliases: WordBreak

Namespace PSWriteOffice

Aliases

WordBreak

Inputs

OfficeIMO.Word.WordParagraph

Outputs

OfficeIMO.Word.WordParagraph

Source

Sources/PSWriteOffice/Cmdlets/Word/AddOfficeWordBreakCommand.cs:17 Edit on GitHub

Adds a break to a Word paragraph.

Remarks

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

Examples

Authored help example

Add a same-paragraph line break.

PS>


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

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

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-OfficeWordBreak [-BreakType <Nullable`1>] [-Count <Int32>] [-Paragraph <WordParagraph>] [-PassThru] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

BreakType Nullable`1 optionalposition: namedpipeline: False: Optional OpenXML break type, for example Page or Column.
Count Int32 optionalposition: namedpipeline: False: Number of breaks to add.
Paragraph WordParagraph optionalposition: namedpipeline: True (ByValue): Target paragraph. When omitted, the current DSL paragraph is used or created.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the paragraph returned by the final break for additional native OfficeIMO chaining.

Outputs

OfficeIMO.Word.WordParagraph