Get Started

API Reference

Cmdlet

Set-OfficeWordParagraphStyle

Aliases: WordParagraphStyle
Namespace PSWriteOffice
Aliases
WordParagraphStyle
Inputs
OfficeIMO.Word.WordParagraph
Outputs
OfficeIMO.Word.WordParagraph
Source
Sources/PSWriteOffice/Cmdlets/Word/SetOfficeWordParagraphStyleCommand.cs:16 Edit on GitHub

Updates paragraph style, spacing, indentation, and pagination hints.

Remarks

Updates paragraph style, spacing, indentation, and pagination hints.

Examples

Authored help example

Style a paragraph in a Word DSL.

PS>


$p = Add-OfficeWordParagraph -Text 'Executive Summary' -PassThru; $p | Set-OfficeWordParagraphStyle -Style Heading1 -KeepWithNext $true

Applies a heading style and keeps it with the next paragraph.

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

Set-OfficeWordParagraphStyle [-Alignment <String>] [-AvoidWidowAndOrphan <Nullable`1>] [-BiDi <Nullable`1>] [-CharacterAlignment <String>] [-IndentationAfterPoints <Nullable`1>] [-IndentationBeforePoints <Nullable`1>] [-IndentationFirstLinePoints <Nullable`1>] [-IndentationHangingPoints <Nullable`1>] [-KeepLinesTogether <Nullable`1>] [-KeepWithNext <Nullable`1>] [-LineSpacingPoints <Nullable`1>] [-LineSpacingRule <String>] [-PageBreakBefore <Nullable`1>] [-Paragraph <WordParagraph>] [-PassThru] [-SpacingAfterPoints <Nullable`1>] [-SpacingBeforePoints <Nullable`1>] [-Style <Nullable`1>] [-StyleId <String>] [-TextDirection <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Alignment String optionalposition: namedpipeline: False
Paragraph alignment.
AvoidWidowAndOrphan Nullable`1 optionalposition: namedpipeline: False
Enable widow and orphan control.
BiDi Nullable`1 optionalposition: namedpipeline: False
Set or clear right-to-left paragraph layout.
CharacterAlignment String optionalposition: namedpipeline: False
Vertical character alignment on each line.
IndentationAfterPoints Nullable`1 optionalposition: namedpipeline: False
Indentation after the paragraph in points.
IndentationBeforePoints Nullable`1 optionalposition: namedpipeline: False
Indentation before the paragraph in points.
IndentationFirstLinePoints Nullable`1 optionalposition: namedpipeline: False
First-line indentation in points.
IndentationHangingPoints Nullable`1 optionalposition: namedpipeline: False
Hanging indentation in points.
KeepLinesTogether Nullable`1 optionalposition: namedpipeline: False
Keep all paragraph lines together.
KeepWithNext Nullable`1 optionalposition: namedpipeline: False
Keep this paragraph with the next paragraph.
LineSpacingPoints Nullable`1 optionalposition: namedpipeline: False
Line spacing in points.
LineSpacingRule String optionalposition: namedpipeline: False
Line spacing calculation rule.
PageBreakBefore Nullable`1 optionalposition: namedpipeline: False
Start the paragraph on a new page.
Paragraph WordParagraph optionalposition: 0pipeline: True (ByValue)
Paragraph to update.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the updated paragraph.
SpacingAfterPoints Nullable`1 optionalposition: namedpipeline: False
Line spacing after the paragraph in points.
SpacingBeforePoints Nullable`1 optionalposition: namedpipeline: False
Line spacing before the paragraph in points.
Style Nullable`1 optionalposition: namedpipeline: False
Paragraph style to apply.
StyleId String optionalposition: namedpipeline: False
Paragraph style id to apply.
TextDirection String optionalposition: namedpipeline: False
Paragraph text direction.

Outputs

OfficeIMO.Word.WordParagraph