Get-OfficePdfFormField

Namespace PSWriteOffice

Inputs

System.String

Outputs

OfficeIMO.Pdf.PdfFormField

Source

Sources/PSWriteOffice/Cmdlets/Pdf/GetOfficePdfFormFieldCommand.cs:16 Edit on GitHub

Gets simple AcroForm fields from a PDF.

Remarks

Gets simple AcroForm fields from a PDF.

Examples

Authored help example

Inspect fields before filling a form.

PS>


Get-OfficePdfFormField -Path .\Examples\Documents\Request.pdf |
                Select-Object Name, FieldType, Value
            Set-OfficePdfForm -Path .\Examples\Documents\Request.pdf -OutputPath .\Examples\Documents\Request-Filled.pdf -Field @{ Requester = 'Ada Lovelace' }

Reads form field names so the fill hashtable can use the right keys.

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

Get-OfficePdfFormField [-Name <String>] [-Password <String>] -Path <String> [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Name String optionalposition: namedpipeline: False: Optional field name filter.
Password String optionalposition: namedpipeline: False: Password used to inspect a Standard password-encrypted PDF.
Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath: PDF file path.

Outputs

OfficeIMO.Pdf.PdfFormField