Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

Stars 159

Forks 14

PowerShell Gallery downloads 158,661

Release v3.0.5

Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Get-OfficeWordField

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument

Outputs

OfficeIMO.Word.WordField

Source

Sources/PSWriteOffice/Cmdlets/Word/GetOfficeWordFieldCommand.cs:24 Edit on GitHub

Gets fields from a Word document.

Remarks

Returns WordField objects, optionally filtered by type or field code.

Examples

Authored help example

Find TOC and page fields before refresh.

PS>


$fields = Get-OfficeWordField -Path .\Report.docx -Contains 'TOC'
            $fields |
                Select-Object -Property FieldType, Field |
                Format-Table -AutoSize

Filters Word fields by field-code text before running a field or table-of-contents refresh.

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-OfficeWordField [-CaseSensitive] [-Contains <String>] [-FieldType <AddressBlock>] -Path <String> [<CommonParameters>]

Parameter set: Path

Parameters

CaseSensitive SwitchParameter optionalposition: namedpipeline: False: Use case-sensitive matching for Contains.
Contains String optionalposition: namedpipeline: False: Filter by field code text.
FieldType WordFieldType[] optionalposition: namedpipeline: Falsevalues: 73: Filter by field type.; Possible values: AddressBlock, Advance, Ask, Author, AutoNum, AutoNumLgl, AutoNumOut, AutoText, AutoTextList, Bibliography, Citation, Comments, Compare, CreateDate, Database, Date, DocProperty, DocVariable, Embed, FileName, FileSize, GoToButton, GreetingLine, HyperlinkIf, IncludePicture, IncludeText, Index, Info, Keywords, LastSavedBy, Link, ListNum, MacroButton, MergeField, MergeRec, MergeSeq, Next, NextIf, NoteRef, NumChars, NumPages, NumWords, Page, PageRef, Print, PrintDate, Private, Quote, RD, Ref, RevNum, SaveDate, Section, SectionPages, Seq, Set, SkipIf, StyleRef, Subject, Symbol, TA, TC, Template, Time, Title, TOA, TOC, UserAddress, UserInitials, UserName, XE, Formula, EQ
Path String requiredposition: 0pipeline: Falsealiases: FilePath, InputPath: Path to the .docx file.

Outputs

OfficeIMO.Word.WordField

Get-OfficeWordField [-CaseSensitive] [-Contains <String>] -Document <WordDocument> [-FieldType <AddressBlock>] [<CommonParameters>]

Parameter set: Document

Parameters

CaseSensitive SwitchParameter optionalposition: namedpipeline: False: Use case-sensitive matching for Contains.
Contains String optionalposition: namedpipeline: False: Filter by field code text.
Document WordDocument requiredposition: namedpipeline: True (ByValue): Word document to read.
FieldType WordFieldType[] optionalposition: namedpipeline: Falsevalues: 73: Filter by field type.; Possible values: AddressBlock, Advance, Ask, Author, AutoNum, AutoNumLgl, AutoNumOut, AutoText, AutoTextList, Bibliography, Citation, Comments, Compare, CreateDate, Database, Date, DocProperty, DocVariable, Embed, FileName, FileSize, GoToButton, GreetingLine, HyperlinkIf, IncludePicture, IncludeText, Index, Info, Keywords, LastSavedBy, Link, ListNum, MacroButton, MergeField, MergeRec, MergeSeq, Next, NextIf, NoteRef, NumChars, NumPages, NumWords, Page, PageRef, Print, PrintDate, Private, Quote, RD, Ref, RevNum, SaveDate, Section, SectionPages, Seq, Set, SkipIf, StyleRef, Subject, Symbol, TA, TC, Template, Time, Title, TOA, TOC, UserAddress, UserInitials, UserName, XE, Formula, EQ

Outputs

OfficeIMO.Word.WordField