Cmdlet

Set-OfficePdfCompliance

Aliases: PdfCompliance

Module: PSWriteOffice
Aliases: PdfCompliance
Inputs: OfficeIMO.Pdf.PdfDocument
Outputs: OfficeIMO.Pdf.PdfDocument
Source: SetOfficePdfComplianceCommand.cs:22 Edit on GitHub

Sets generated PDF compliance profile and readiness groundwork.

Syntax

Set-OfficePdfCompliance
[-Groundwork]
[-Language <String>]
[-PassThru]
-Profile <PdfComplianceProfile>
[<CommonParameters>]

Parameter set: Context

Set-OfficePdfCompliance
-Document <PdfDocument>
[-Groundwork]
[-Language <String>]
[-PassThru]
-Profile <PdfComplianceProfile>
[<CommonParameters>]

Parameter set: Document

Examples

Configure PDF/A groundwork before saving.

$path = '.\Examples\Documents\PdfCompliance.pdf'
New-OfficePdf -Path $path {
    Set-OfficePdfCompliance -Profile PdfA3B -Groundwork -Language 'en-US'
    Add-OfficePdfHeading -Text 'Compliance-ready report'
}
Get-OfficePdfCompliance -Path $path -Profile PdfA3B

Applies OfficeIMO.Pdf compliance groundwork during composition, saves the PDF, then inspects the saved file.

Parameters

-Groundwork SwitchParameter optional: Configure common PDF/A or PDF/UA groundwork for the selected profile.
-Language String optional: Catalog language used by compliance groundwork.
-PassThru SwitchParameter optional: Emit the updated document.
-Profile PdfComplianceProfile required: Requested generated PDF compliance profile.; Possible values: PdfA2B, PdfA2U, PdfA2A, PdfA3B, PdfA3U, PdfA3A, PdfUa1, FacturX, Zugferd, PdfA4, PdfA4E, PdfA4F, PdfUa2, PdfX1A2003, PdfX4
-Document PdfDocument requiredpipeline: True (ByValue)sets: Document: Compatibility parameter. Compliance options must be declared inside New-OfficePdf.

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.