Add-OfficePdfParagraph

Aliases: PdfParagraph

Namespace PSWriteOffice

Aliases

PdfParagraph

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

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

Adds a paragraph to a PDF document.

Remarks

Adds a paragraph to a PDF document.

Examples

Authored help example

Add body text to a generated PDF.

PS>


New-OfficePdf -Path .\Examples\Documents\PdfParagraph.pdf {
                Add-OfficePdfHeading -Text 'Status'
                Add-OfficePdfParagraph -Text 'All monitored services are currently healthy.' -Color '#166534'
            }

Adds a colored body paragraph after a heading.

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-OfficePdfParagraph [-Align <Left|Center|Right|Justify>] [-Color <String>] [-PassThru] -Text <String> [<CommonParameters>]

Parameter set: Context

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Paragraph alignment.; Possible values: Left, Center, Right, Justify
Color String optionalposition: namedpipeline: False: Optional text color in #RRGGBB format.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.
Text String requiredposition: 0pipeline: False: Paragraph text.

Outputs

OfficeIMO.Pdf.PdfDocument

Add-OfficePdfParagraph [-Align <Left|Center|Right|Justify>] [-Color <String>] -Document <PdfDocument> [-PassThru] -Text <String> [<CommonParameters>]

Parameter set: Document

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Paragraph alignment.; Possible values: Left, Center, Right, Justify
Color String optionalposition: namedpipeline: False: Optional text color in #RRGGBB format.
Document PdfDocument requiredposition: namedpipeline: True (ByValue): PDF document to update outside the DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.
Text String requiredposition: 0pipeline: False: Paragraph text.

Outputs

OfficeIMO.Pdf.PdfDocument