Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Get-OfficePdfCompliance

Module
PSWriteOffice
Inputs
OfficeIMO.Pdf.PdfDocument System.String
Outputs
OfficeIMO.Pdf.PdfComplianceReadinessReport OfficeIMO.Pdf.PdfComplianceProofReport

Gets a generated PDF document compliance readiness report.

Syntax

Get-OfficePdfCompliance
[-Document <PdfDocument>]
[-ExternalArguments <String>]
[-ExternalDiagnostic <String>]
[-ExternalExecutablePath <String>]
[-ExternalExitCode <Int32>]
[-ExternalProfile <String>]
[-ExternalStatus <NotRun|Passed|Failed|Error>]
[-ExternalSuccessExitCode <Int32>]
[-ExternalValidation <PdfExternalValidationResult[]>]
[-ExternalValidator <VeraPdf|PdfUaValidator|Mustang|Custom|PdfXValidator>]
[-ExternalValidatorName <String>]
[-ExternalValidatorVersion <String>]
[-Profile <PdfComplianceProfile>]
[-Proof]
[<CommonParameters>]
#
Parameter set: Document
Get-OfficePdfCompliance
[-ExternalArguments <String>]
[-ExternalDiagnostic <String>]
[-ExternalExecutablePath <String>]
[-ExternalExitCode <Int32>]
[-ExternalProfile <String>]
[-ExternalStatus <NotRun|Passed|Failed|Error>]
[-ExternalSuccessExitCode <Int32>]
[-ExternalValidation <PdfExternalValidationResult[]>]
[-ExternalValidator <VeraPdf|PdfUaValidator|Mustang|Custom|PdfXValidator>]
[-ExternalValidatorName <String>]
[-ExternalValidatorVersion <String>]
[-IgnorePermissionRestrictions]
[-Password <String>]
[-Path] <String>
-Profile <PdfComplianceProfile>
[-Proof]
[<CommonParameters>]
#
Parameter set: Path

Examples

Check generated PDF compliance readiness.

$pdf = New-OfficePdf {
    Set-OfficePdfCompliance -Profile PdfA3B -Groundwork
    Add-OfficePdfHeading -Text 'Compliance readiness'
} -NoSave
$pdf | Get-OfficePdfCompliance -Profile PdfA3B

Returns the OfficeIMO.Pdf readiness report before saving.

Parameters

-Document PdfDocument optionalpipeline: True (ByValue)sets: Document
Generated PDF document to assess outside the DSL context.
-ExternalArguments String optional
External validator command-line arguments recorded in the proof evidence.
-ExternalDiagnostic String optional
Human-readable external validation diagnostic.
-ExternalExecutablePath String optional
External validator executable path recorded in the proof evidence.
-ExternalExitCode Int32 optional
External validator process exit code. When provided, status is inferred from -ExternalSuccessExitCode.
-ExternalProfile String optional
Profile string reported by the external validator, for example PDF/A-3b.
-ExternalStatus PdfExternalValidationStatus optional
Unbound external validator status to attach when -ExternalValidator is provided.
Possible values: NotRun, Passed, Failed, Error
-ExternalSuccessExitCode Int32 optional
External validator process exit code that means success.
-ExternalValidation PdfExternalValidationResult[] optional
Artifact-bound results produced by the external validation lane. Use PdfExternalValidationResult.PassedForArtifact or FromExitCodeForArtifact with the exact validated bytes.
-ExternalValidator PdfExternalValidatorKind[] optional
External validator families whose result should be attached to the proof report.
Possible values: VeraPdf, PdfUaValidator, Mustang, Custom, PdfXValidator
-ExternalValidatorName String optional
Human-readable external validator name.
-ExternalValidatorVersion String optional
External validator version recorded in the artifact-bound proof evidence.
-Profile PdfComplianceProfile required in Path
Compliance profile to assess. When omitted, the document's configured profile is used.
Possible values: PdfA2B, PdfA2U, PdfA2A, PdfA3B, PdfA3U, PdfA3A, PdfUa1, FacturX, Zugferd, PdfA4, PdfA4E, PdfA4F, PdfUa2, PdfX1A2003, PdfX4
-Proof SwitchParameter optional
Return a proof report that combines readiness with required external validator evidence placeholders.
-IgnorePermissionRestrictions SwitchParameter optionalsets: Path
After successful password authentication, explicitly ignore owner-imposed usage restrictions.
-Password String optionalsets: Path
Password used to inspect a Standard password-encrypted PDF.
-Path String requiredposition: 0pipeline: True (ByPropertyName)aliases: FilePathsets: Path
Existing PDF file path to assess after generation.

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.