Add-OfficePdfList

Aliases: PdfList

Namespace PSWriteOffice

Aliases

PdfList

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

Sources/PSWriteOffice/Cmdlets/Pdf/AddOfficePdfListCommand.cs:17 Edit on GitHub

Adds a bullet or numbered list to a PDF document.

Remarks

Adds a bullet or numbered list to a PDF document.

Examples

Authored help example

Add action items to a report.

PS>


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.

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-OfficePdfList [-Align <Left|Center|Right|Justify>] -Items <String[]> [-Numbered] [-PassThru] [-StartNumber <Int32>] [<CommonParameters>]

Parameter set: Context

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: List alignment.; Possible values: Left, Center, Right, Justify
Items String[] requiredposition: 0pipeline: False: List item text.
Numbered SwitchParameter optionalposition: namedpipeline: False: Create a numbered list instead of a bullet list.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.
StartNumber Int32 optionalposition: namedpipeline: False: Number to use for the first numbered item.

Outputs

OfficeIMO.Pdf.PdfDocument

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

Parameter set: Document

Parameters

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

Outputs

OfficeIMO.Pdf.PdfDocument