Skip to content

Get-OfficeWordField.md

Latest commit

 

History

History
130 lines (100 loc) · 3.05 KB

Get-OfficeWordField.md

File metadata and controls

130 lines (100 loc) · 3.05 KB
external help file PSWriteOffice-help.xml
Module Name PSWriteOffice
online version https://github.com/EvotecIT/PSWriteOffice
schema 2.0.0

Get-OfficeWordField

SYNOPSIS

Gets fields from a Word document.

SYNTAX

Path (Default)

Get-OfficeWordField [-InputPath] <string> [-FieldType <WordFieldType[]>] [-Contains <string>] [-CaseSensitive] [<CommonParameters>]

Document

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

DESCRIPTION

Gets fields from a Word document.

EXAMPLES

EXAMPLE 1

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

Returns all fields in the document.

PARAMETERS

-CaseSensitive

Use case-sensitive matching for Contains.

Type: SwitchParameter
Parameter Sets: Path, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Contains

Filter by field code text.

Type: String
Parameter Sets: Path, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Document

Word document to read.

Type: WordDocument
Parameter Sets: Document
Aliases: None
Possible values: 

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-FieldType

Filter by field type.

Type: WordFieldType[]
Parameter Sets: Path, Document
Aliases: None
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

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-InputPath

Path to the .docx file.

Type: String
Parameter Sets: Path
Aliases: FilePath, Path
Possible values: 

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • OfficeIMO.Word.WordDocument

OUTPUTS

  • OfficeIMO.Word.WordField

RELATED LINKS

  • None