Set-OfficeWordPageSetup

Aliases: WordPageSetup

Namespace PSWriteOffice

Aliases

WordPageSetup

Inputs

OfficeIMO.Word.WordDocument OfficeIMO.Word.WordSection

Outputs

OfficeIMO.Word.WordSection

Source

Sources/PSWriteOffice/Cmdlets/Word/SetOfficeWordPageSetupCommand.cs:22 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 <Int32>] [-Columns <Int32>] [-ColumnSeparator <Boolean>] [-ColumnSpacing <Int32>] [-Footer <Int32>] [-Gutter <Int32>] [-Header <Int32>] [-Left <Int32>] [-Margin <Normal>] [-Orientation <Portrait|Landscape>] [-PageSize <Unknown>] [-PassThru] [-Right <Int32>] [-Top <Int32>] [<CommonParameters>]

Parameter set: Current

Parameters

Bottom Int32 optionalposition: namedpipeline: False: Bottom margin in twips.
Columns Int32 optionalposition: namedpipeline: False: Number of section columns.
ColumnSeparator Boolean optionalposition: namedpipeline: False: Whether to show a separator between columns.
ColumnSpacing Int32 optionalposition: namedpipeline: False: Space between columns in twips.
Footer Int32 optionalposition: namedpipeline: False: Footer distance in twips.
Gutter Int32 optionalposition: namedpipeline: False: Gutter size in twips.
Header Int32 optionalposition: namedpipeline: False: Header distance in twips.
Left Int32 optionalposition: namedpipeline: False: Left margin in twips.
Margin WordMargin optionalposition: namedpipeline: Falsevalues: 7: Built-in margin preset.; Possible values: Normal, Mirrored, Moderate, Narrow, Wide, Office2003Default, Unknown
Orientation String optionalposition: namedpipeline: Falsevalues: 2: Page orientation.; Possible values: Portrait, Landscape
PageSize WordPageSize optionalposition: namedpipeline: Falsevalues: 10: Built-in page size.; Possible values: Unknown, Letter, Legal, Statement, Executive, A3, A4, A5, A6, B5
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit updated sections.
Right Int32 optionalposition: namedpipeline: False: Right margin in twips.
Top Int32 optionalposition: namedpipeline: False: Top margin in twips.

Outputs

OfficeIMO.Word.WordSection

Set-OfficeWordPageSetup [-Bottom <Int32>] [-Columns <Int32>] [-ColumnSeparator <Boolean>] [-ColumnSpacing <Int32>] [-Footer <Int32>] [-Gutter <Int32>] [-Header <Int32>] [-Left <Int32>] [-Margin <Normal>] [-Orientation <Portrait|Landscape>] [-PageSize <Unknown>] [-PassThru] [-Right <Int32>] -Section <WordSection> [-Top <Int32>] [<CommonParameters>]

Parameter set: Section

Parameters

Bottom Int32 optionalposition: namedpipeline: False: Bottom margin in twips.
Columns Int32 optionalposition: namedpipeline: False: Number of section columns.
ColumnSeparator Boolean optionalposition: namedpipeline: False: Whether to show a separator between columns.
ColumnSpacing Int32 optionalposition: namedpipeline: False: Space between columns in twips.
Footer Int32 optionalposition: namedpipeline: False: Footer distance in twips.
Gutter Int32 optionalposition: namedpipeline: False: Gutter size in twips.
Header Int32 optionalposition: namedpipeline: False: Header distance in twips.
Left Int32 optionalposition: namedpipeline: False: Left margin in twips.
Margin WordMargin optionalposition: namedpipeline: Falsevalues: 7: Built-in margin preset.; Possible values: Normal, Mirrored, Moderate, Narrow, Wide, Office2003Default, Unknown
Orientation String optionalposition: namedpipeline: Falsevalues: 2: Page orientation.; Possible values: Portrait, Landscape
PageSize WordPageSize optionalposition: namedpipeline: Falsevalues: 10: Built-in page size.; Possible values: Unknown, Letter, Legal, Statement, Executive, A3, A4, A5, A6, B5
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit updated sections.
Right Int32 optionalposition: namedpipeline: False: Right margin in twips.
Section WordSection requiredposition: namedpipeline: True (ByValue): Section to update.
Top Int32 optionalposition: namedpipeline: False: Top margin in twips.

Outputs

OfficeIMO.Word.WordSection

Set-OfficeWordPageSetup [-Bottom <Int32>] [-Columns <Int32>] [-ColumnSeparator <Boolean>] [-ColumnSpacing <Int32>] -Document <WordDocument> [-Footer <Int32>] [-Gutter <Int32>] [-Header <Int32>] [-Index <Int32[]>] [-Left <Int32>] [-Margin <Normal>] [-Orientation <Portrait|Landscape>] [-PageSize <Unknown>] [-PassThru] [-Right <Int32>] [-Top <Int32>] [<CommonParameters>]

Parameter set: Document

Parameters

Bottom Int32 optionalposition: namedpipeline: False: Bottom margin in twips.
Columns Int32 optionalposition: namedpipeline: False: Number of section columns.
ColumnSeparator Boolean optionalposition: namedpipeline: False: Whether to show a separator between columns.
ColumnSpacing Int32 optionalposition: namedpipeline: False: Space between columns in twips.
Document WordDocument requiredposition: namedpipeline: True (ByValue): Document whose sections should be updated.
Footer Int32 optionalposition: namedpipeline: False: Footer distance in twips.
Gutter Int32 optionalposition: namedpipeline: False: Gutter size in twips.
Header Int32 optionalposition: namedpipeline: False: Header distance in twips.
Index Int32[] optionalposition: namedpipeline: False: Optional 0-based section indexes when -Document is used.
Left Int32 optionalposition: namedpipeline: False: Left margin in twips.
Margin WordMargin optionalposition: namedpipeline: Falsevalues: 7: Built-in margin preset.; Possible values: Normal, Mirrored, Moderate, Narrow, Wide, Office2003Default, Unknown
Orientation String optionalposition: namedpipeline: Falsevalues: 2: Page orientation.; Possible values: Portrait, Landscape
PageSize WordPageSize optionalposition: namedpipeline: Falsevalues: 10: Built-in page size.; Possible values: Unknown, Letter, Legal, Statement, Executive, A3, A4, A5, A6, B5
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit updated sections.
Right Int32 optionalposition: namedpipeline: False: Right margin in twips.
Top Int32 optionalposition: namedpipeline: False: Top margin in twips.

Outputs

OfficeIMO.Word.WordSection