Cmdlet

Add-OfficePdfList

Aliases: PdfList

Module PSWriteOffice

Aliases

PdfList

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

AddOfficePdfListCommand.cs:20 Edit on GitHub

Adds a bullet or numbered list to a PDF document.

Syntax

Add-OfficePdfList [-Align <Left|Center|Right|Justify>] [-Items] <String[]> [-Numbered] [-PassThru] [-StartNumber <Int32>] [<CommonParameters>]

Parameter set: Context

Add-OfficePdfList [-Align <Left|Center|Right|Justify>] -Document <PdfDocument> [-Items] <String[]> [-Numbered] [-PassThru] [-StartNumber <Int32>] [<CommonParameters>]

Parameter set: Document

Examples

Authored help example

Add action items to a report.

New-OfficePdf -Path .\Examples\Documents\PdfList.pdf {
    Add-OfficePdfHeading -Text 'Next actions'
    Add-OfficePdfList -Items 'Confirm owner','Publish summary','Schedule review' -Numbered
}

Adds a numbered list in the generated PDF flow.

Parameters

-Align PdfAlign optional: List alignment.; Possible values: Left, Center, Right, Justify
-Items String[] requiredposition: 0: List item text.
-Numbered SwitchParameter optional: Create a numbered list instead of a bullet list.
-PassThru SwitchParameter optional: Emit the updated document.
-StartNumber Int32 optional: Number to use for the first numbered item.
-Document PdfDocument requiredpipeline: True (ByValue)sets: Document: PDF document to update outside the DSL context.

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.