Project

PSWriteOffice

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

View on GitHub Releases Get package
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-OfficePdfFormField

Module
PSWriteOffice
Inputs
System.String
Outputs
OfficeIMO.Pdf.PdfFormField
Source
GetOfficePdfFormFieldCommand.cs:18 Edit on GitHub

Gets simple AcroForm fields from a PDF.

Syntax

Get-OfficePdfFormField
[-IgnorePermissionRestrictions]
[-Name <String>]
[-Password <String>]
[-Path] <String>
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Inspect fields before filling a form.

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.

Parameters

-IgnorePermissionRestrictions SwitchParameter optional
After successful password authentication, explicitly ignore owner-imposed usage restrictions.
-Name String optional
Optional field name filter.
-Password String optional
Password used to inspect a Standard password-encrypted PDF.
-Path String requiredposition: 0pipeline: True (ByValue)aliases: FilePath
PDF file path.

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.