Get Started

API Reference

Cmdlet

Set-OfficeWordPageSetup

Aliases: WordPageSetup
Namespace PSWriteOffice
Aliases
WordPageSetup
Inputs
OfficeIMO.Word.WordSection OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordSection
Source
Sources/PSWriteOffice/Cmdlets/Word/SetOfficeWordPageSetupCommand.cs:18 Edit on GitHub

Sets page setup options on Word sections.

Remarks

Updates page size, orientation, margins, and section columns through OfficeIMO.Word.

Examples

Authored help example

Use landscape A4 with two columns.

PS>


Add-OfficeWordSection { Set-OfficeWordPageSetup -PageSize A4 -Orientation Landscape -Columns 2 }

Updates the current section page setup.

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-OfficeWordPageSetup [-Bottom <Nullable`1>] [-Columns <Nullable`1>] [-ColumnSeparator <Nullable`1>] [-ColumnSpacing <Nullable`1>] [-Footer <Nullable`1>] [-Gutter <Nullable`1>] [-Header <Nullable`1>] [-Left <Nullable`1>] [-Margin <Nullable`1>] [-Orientation <Portrait|Landscape>] [-PageSize <Nullable`1>] [-PassThru] [-Right <Nullable`1>] [-Top <Nullable`1>] [<CommonParameters>]
#
Parameter set: Current

Parameters

Bottom Nullable`1 optionalposition: namedpipeline: False
Bottom margin in twips.
Columns Nullable`1 optionalposition: namedpipeline: False
Number of section columns.
ColumnSeparator Nullable`1 optionalposition: namedpipeline: False
Whether to show a separator between columns.
ColumnSpacing Nullable`1 optionalposition: namedpipeline: False
Space between columns in twips.
Footer Nullable`1 optionalposition: namedpipeline: False
Footer distance in twips.
Gutter Nullable`1 optionalposition: namedpipeline: False
Gutter size in twips.
Header Nullable`1 optionalposition: namedpipeline: False
Header distance in twips.
Left Nullable`1 optionalposition: namedpipeline: False
Left margin in twips.
Margin Nullable`1 optionalposition: namedpipeline: False
Built-in margin preset.
Orientation String optionalposition: namedpipeline: Falsevalues: 2
Page orientation.
Possible values: Portrait, Landscape
PageSize Nullable`1 optionalposition: namedpipeline: False
Built-in page size.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit updated sections.
Right Nullable`1 optionalposition: namedpipeline: False
Right margin in twips.
Top Nullable`1 optionalposition: namedpipeline: False
Top margin in twips.

Outputs

OfficeIMO.Word.WordSection

Set-OfficeWordPageSetup [-Bottom <Nullable`1>] [-Columns <Nullable`1>] [-ColumnSeparator <Nullable`1>] [-ColumnSpacing <Nullable`1>] [-Footer <Nullable`1>] [-Gutter <Nullable`1>] [-Header <Nullable`1>] [-Left <Nullable`1>] [-Margin <Nullable`1>] [-Orientation <Portrait|Landscape>] [-PageSize <Nullable`1>] [-PassThru] [-Right <Nullable`1>] -Section <WordSection> [-Top <Nullable`1>] [<CommonParameters>]
#
Parameter set: Section

Parameters

Bottom Nullable`1 optionalposition: namedpipeline: False
Bottom margin in twips.
Columns Nullable`1 optionalposition: namedpipeline: False
Number of section columns.
ColumnSeparator Nullable`1 optionalposition: namedpipeline: False
Whether to show a separator between columns.
ColumnSpacing Nullable`1 optionalposition: namedpipeline: False
Space between columns in twips.
Footer Nullable`1 optionalposition: namedpipeline: False
Footer distance in twips.
Gutter Nullable`1 optionalposition: namedpipeline: False
Gutter size in twips.
Header Nullable`1 optionalposition: namedpipeline: False
Header distance in twips.
Left Nullable`1 optionalposition: namedpipeline: False
Left margin in twips.
Margin Nullable`1 optionalposition: namedpipeline: False
Built-in margin preset.
Orientation String optionalposition: namedpipeline: Falsevalues: 2
Page orientation.
Possible values: Portrait, Landscape
PageSize Nullable`1 optionalposition: namedpipeline: False
Built-in page size.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit updated sections.
Right Nullable`1 optionalposition: namedpipeline: False
Right margin in twips.
Section WordSection requiredposition: namedpipeline: True (ByValue)
Section to update.
Top Nullable`1 optionalposition: namedpipeline: False
Top margin in twips.

Outputs

OfficeIMO.Word.WordSection

Set-OfficeWordPageSetup [-Bottom <Nullable`1>] [-Columns <Nullable`1>] [-ColumnSeparator <Nullable`1>] [-ColumnSpacing <Nullable`1>] -Document <WordDocument> [-Footer <Nullable`1>] [-Gutter <Nullable`1>] [-Header <Nullable`1>] [-Index <Int32[]>] [-Left <Nullable`1>] [-Margin <Nullable`1>] [-Orientation <Portrait|Landscape>] [-PageSize <Nullable`1>] [-PassThru] [-Right <Nullable`1>] [-Top <Nullable`1>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Bottom Nullable`1 optionalposition: namedpipeline: False
Bottom margin in twips.
Columns Nullable`1 optionalposition: namedpipeline: False
Number of section columns.
ColumnSeparator Nullable`1 optionalposition: namedpipeline: False
Whether to show a separator between columns.
ColumnSpacing Nullable`1 optionalposition: namedpipeline: False
Space between columns in twips.
Document WordDocument requiredposition: namedpipeline: True (ByValue)
Document whose sections should be updated.
Footer Nullable`1 optionalposition: namedpipeline: False
Footer distance in twips.
Gutter Nullable`1 optionalposition: namedpipeline: False
Gutter size in twips.
Header Nullable`1 optionalposition: namedpipeline: False
Header distance in twips.
Index Int32[] optionalposition: namedpipeline: False
Optional 0-based section indexes when -Document is used.
Left Nullable`1 optionalposition: namedpipeline: False
Left margin in twips.
Margin Nullable`1 optionalposition: namedpipeline: False
Built-in margin preset.
Orientation String optionalposition: namedpipeline: Falsevalues: 2
Page orientation.
Possible values: Portrait, Landscape
PageSize Nullable`1 optionalposition: namedpipeline: False
Built-in page size.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit updated sections.
Right Nullable`1 optionalposition: namedpipeline: False
Right margin in twips.
Top Nullable`1 optionalposition: namedpipeline: False
Top margin in twips.

Outputs

OfficeIMO.Word.WordSection