Cmdlet

Get-OfficeWordField

Module: PSWriteOffice
Inputs: OfficeIMO.Word.WordDocument
Outputs: OfficeIMO.Word.WordField
Source: GetOfficeWordFieldCommand.cs:24 Edit on GitHub

Gets fields from a Word document.

Syntax

Get-OfficeWordField
[-CaseSensitive]
[-Contains <String>]
[-FieldType <WordFieldType[]>]
[-Path] <String>
[<CommonParameters>]

Parameter set: Path

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

Parameter set: Document

Description

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

Examples

Find TOC and page fields before refresh.

$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.

Parameters

-CaseSensitive SwitchParameter optional: Use case-sensitive matching for Contains.
-Contains String optional: Filter by field code text.
-FieldType WordFieldType[] optional: 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: 0aliases: FilePath, InputPathsets: Path: Path to the .docx file.
-Document WordDocument requiredpipeline: True (ByValue)sets: Document: Word document to read.

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.