OfficeIMO

API Reference

Command

Get-OfficeWordField

Namespace PSWriteOffice
Inputs
OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordField

Gets fields from a Word document.

Remarks

Gets fields from a Word document.

Examples

List all fields.


PS>Get-OfficeWordField -Path .\Report.docx

Returns all fields in the document.

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>] -InputPath <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: 71
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
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
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: 71
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

Outputs

OfficeIMO.Word.WordField