Cmdlet

Get-OfficeWordField

Module: PSWriteOffice
Inputs: OfficeIMO.Word.WordDocument System.String[]
Outputs: OfficeIMO.Word.WordField
Source: GetOfficeWordFieldCommand.cs:10 Edit on GitHub

Gets fields, filtered by type or field code text.

Syntax

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

Parameter set: Document

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

Parameter set: Path

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

Parameter set: LiteralPath

Examples

Example 1

Get-OfficeWordField -CaseSensitive

Example 2

Get-OfficeWordField -LiteralPath @('C:\Path')

Example 3

Get-OfficeWordField -Path @('C:\Path')

Parameters

-CaseSensitive SwitchParameter optional: CaseSensitive for this inspection.
-Contains String optional: Contains for this inspection.
-Document WordDocument optionalpipeline: True (ByValue)sets: Document: Document for this inspection.
-FieldType WordFieldType[] optional: FieldType for this inspection.; 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: True (ByValue)sets: Path: Path for this inspection.
-LiteralPath String[] requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: LiteralPath for this inspection.

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.