Cmdlet

Add-OfficePdfImage

Aliases: PdfImage

Module: PSWriteOffice
Aliases: PdfImage
Inputs: OfficeIMO.Pdf.PdfDocument
Outputs: OfficeIMO.Pdf.PdfDocument
Source: AddOfficePdfImageCommand.cs:21 Edit on GitHub

Adds an image to a PDF document.

Syntax

Add-OfficePdfImage
[-Align <Left|Center|Right|Justify>]
[-AlternativeText <String>]
-Height <Double>
[-PassThru]
[-Path] <String>
-Width <Double>
[<CommonParameters>]

Parameter set: Context

Add-OfficePdfImage
[-Align <Left|Center|Right|Justify>]
[-AlternativeText <String>]
-Document <PdfDocument>
-Height <Double>
[-PassThru]
[-Path] <String>
-Width <Double>
[<CommonParameters>]

Parameter set: Document

Examples

Add a logo or chart image to a PDF.

$image = '.\Tests\Assets\CellImage.png'
New-OfficePdf -Path .\Examples\Documents\PdfImage.pdf {
    Add-OfficePdfHeading -Text 'Visual evidence'
    Add-OfficePdfImage -Path $image -Width 120 -Height 80 -Align Center -AlternativeText 'Sample chart image'
}

Embeds an image with alternative text in the generated PDF.

Parameters

-Align PdfAlign optional: Image alignment.; Possible values: Left, Center, Right, Justify
-AlternativeText String optional: Alternative text for meaningful images.
-Height Double required: Rendered image height in PDF points.
-PassThru SwitchParameter optional: Emit the updated document.
-Path String requiredposition: 0aliases: FilePath: Image path.
-Width Double required: Rendered image width in PDF points.
-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.