ConvertTo-OfficePdfFlatForm

Namespace PSWriteOffice

Inputs

System.String

Outputs

System.IO.FileInfo

Source

Sources/PSWriteOffice/Cmdlets/Pdf/ConvertToOfficePdfFlatFormCommand.cs:21 Edit on GitHub

Converts a PDF with simple AcroForm fields into a flat PDF.

Remarks

Converts a PDF with simple AcroForm fields into a flat PDF.

Examples

Authored help example

Flatten a filled PDF form.

PS>


Set-OfficePdfForm -Path .\Examples\Documents\Request.pdf -OutputPath .\Examples\Documents\Request-Filled.pdf -Field @{
                Requester = 'Ada Lovelace'
                Priority = 'High'
            }
            ConvertTo-OfficePdfFlatForm -Path .\Examples\Documents\Request-Filled.pdf -OutputPath .\Examples\Documents\Request-Flat.pdf

Turns simple form fields into static page content.

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

ConvertTo-OfficePdfFlatForm [-AppearanceFontFamilyName <String>] [-AppearanceFontPath <String>] [-IgnorePermissionRestrictions] -OutputPath <String> [-Password <String>] -Path <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

AppearanceFontFamilyName String optionalposition: namedpipeline: False: PDF font family name used for the supplied appearance font.
AppearanceFontPath String optionalposition: namedpipeline: False: TrueType or OpenType/CFF font file used to synthesize Unicode form field appearances while flattening.
IgnorePermissionRestrictions SwitchParameter optionalposition: namedpipeline: False: After successful password authentication, explicitly ignore owner-imposed form-modification restrictions.
OutputPath String requiredposition: 1pipeline: False: Output PDF path.
Password String optionalposition: namedpipeline: False: Password used to authenticate an encrypted PDF.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: Input PDF path.

Outputs

System.IO.FileInfo