API Reference

Cmdlet

Add-OfficeWordCoverPage

Aliases: WordCoverPage
Namespace PSWriteOffice
Aliases
WordCoverPage
Inputs
OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordCoverPage

Adds a built-in cover page template to a Word document.

Remarks

Uses OfficeIMO.Word cover page templates and optional cover-page metadata.

Examples

Authored help example

Add a cover page in the Word DSL.

PS>


New-OfficeWord -Path .\Report.docx { Add-OfficeWordCoverPage -Template Element -Abstract 'Executive summary' }
        

Creates a document with a template-driven cover page.

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-OfficeWordCoverPage [-Abstract <String>] [-CompanyAddress <String>] [-CompanyEmail <String>] [-Document <WordDocument>] [-PassThru] [-PublishDate <String>] -Template <Austin> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Abstract String optionalposition: namedpipeline: False
Abstract/summary stored in the cover page properties custom XML part.
CompanyAddress String optionalposition: namedpipeline: False
Company address stored in the cover page properties custom XML part.
CompanyEmail String optionalposition: namedpipeline: False
Company email stored in the cover page properties custom XML part.
Document WordDocument optionalposition: namedpipeline: True (ByValue)
Document to update. Defaults to the current Word DSL or tracked document.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the created cover page.
PublishDate String optionalposition: namedpipeline: False
Publish date stored in the cover page properties custom XML part.
Template CoverPageTemplate requiredposition: 0pipeline: Falsevalues: 14
Cover page template to insert.
Possible values: Austin, Banded, Facet, Grid, IonDark, IonLight, Element, Wisp, ViewMaster, SliceLight, SliceDark, SideLine, Semaphore, Retrospect

Outputs

OfficeIMO.Word.WordCoverPage