Add-OfficePdfImage

Aliases: PdfImage

Namespace PSWriteOffice

Aliases

PdfImage

Inputs

OfficeIMO.Pdf.PdfDocument

Outputs

OfficeIMO.Pdf.PdfDocument

Source

Sources/PSWriteOffice/Cmdlets/Pdf/AddOfficePdfImageCommand.cs:19 Edit on GitHub

Adds an image to a PDF document.

Remarks

Adds an image to a PDF document.

Examples

Authored help example

Add a logo or chart image to a PDF.

PS>


$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.

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

Parameter set: Context

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Image alignment.; Possible values: Left, Center, Right, Justify
AlternativeText String optionalposition: namedpipeline: False: Alternative text for meaningful images.
Height Double requiredposition: namedpipeline: False: Rendered image height in PDF points.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.
Path String requiredposition: 0pipeline: Falsealiases: FilePath: Image path.
Width Double requiredposition: namedpipeline: False: Rendered image width in PDF points.

Outputs

OfficeIMO.Pdf.PdfDocument

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

Parameter set: Document

Parameters

Align PdfAlign optionalposition: namedpipeline: Falsevalues: 4: Image alignment.; Possible values: Left, Center, Right, Justify
AlternativeText String optionalposition: namedpipeline: False: Alternative text for meaningful images.
Document PdfDocument requiredposition: namedpipeline: True (ByValue): PDF document to update outside the DSL context.
Height Double requiredposition: namedpipeline: False: Rendered image height in PDF points.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit the updated document.
Path String requiredposition: 0pipeline: Falsealiases: FilePath: Image path.
Width Double requiredposition: namedpipeline: False: Rendered image width in PDF points.

Outputs

OfficeIMO.Pdf.PdfDocument