Get Started

API Reference

Cmdlet

Set-OfficePdfCompliance

Aliases: PdfCompliance
Namespace PSWriteOffice
Aliases
PdfCompliance
Inputs
OfficeIMO.Pdf.PdfDocument
Outputs
OfficeIMO.Pdf.PdfDocument
Source
Sources/PSWriteOffice/Cmdlets/Pdf/SetOfficePdfComplianceCommand.cs:18 Edit on GitHub

Sets generated PDF compliance profile and readiness groundwork.

Remarks

Sets generated PDF compliance profile and readiness groundwork.

Examples

Authored help example

Configure PDF/A groundwork before saving.

PS>


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

Applies OfficeIMO.Pdf compliance groundwork and emits a readiness report inside the DSL.

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

Set-OfficePdfCompliance [-Groundwork] [-Language <String>] [-PassThru] -Profile <PdfA2B> [<CommonParameters>]
#
Parameter set: Context

Parameters

Groundwork SwitchParameter optionalposition: namedpipeline: False
Configure common PDF/A or PDF/UA groundwork for the selected profile.
Language String optionalposition: namedpipeline: False
Catalog language used by compliance groundwork.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the updated document.
Profile PdfComplianceProfile requiredposition: namedpipeline: Falsevalues: 13
Requested generated PDF compliance profile.
Possible values: PdfA2B, PdfA2U, PdfA2A, PdfA3B, PdfA3U, PdfA3A, PdfUa1, FacturX, Zugferd, PdfA4, PdfA4E, PdfA4F, PdfUa2

Outputs

OfficeIMO.Pdf.PdfDocument

Set-OfficePdfCompliance -Document <PdfDocument> [-Groundwork] [-Language <String>] [-PassThru] -Profile <PdfA2B> [<CommonParameters>]
#
Parameter set: Document

Parameters

Document PdfDocument requiredposition: namedpipeline: True (ByValue)
PDF document to update outside the DSL context.
Groundwork SwitchParameter optionalposition: namedpipeline: False
Configure common PDF/A or PDF/UA groundwork for the selected profile.
Language String optionalposition: namedpipeline: False
Catalog language used by compliance groundwork.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the updated document.
Profile PdfComplianceProfile requiredposition: namedpipeline: Falsevalues: 13
Requested generated PDF compliance profile.
Possible values: PdfA2B, PdfA2U, PdfA2A, PdfA3B, PdfA3U, PdfA3A, PdfUa1, FacturX, Zugferd, PdfA4, PdfA4E, PdfA4F, PdfUa2

Outputs

OfficeIMO.Pdf.PdfDocument