Get Started

API Reference

Cmdlet

Get-OfficeWordDropDownList

Aliases: WordDropDownLists
Namespace PSWriteOffice
Aliases
WordDropDownLists
Inputs
OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordDropDownList
Source
Sources/PSWriteOffice/Cmdlets/Word/GetOfficeWordDropDownListCommand.cs:24 Edit on GitHub

Gets dropdown list content controls from a Word document.

Remarks

Gets dropdown list content controls from a Word document.

Examples

Authored help example

Example 1: Check status dropdown controls.

PS>


$statusControls = Get-OfficeWordDropDownList -Path .\StatusForm.docx -Tag 'status-*'
            $statusControls |
                Select-Object -Property Alias, Tag |
                Format-Table -AutoSize

Finds dropdown list content controls used for status capture in a Word form.

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-OfficeWordDropDownList [-Alias <String[]>] -InputPath <String> [-Tag <String[]>] [<CommonParameters>]
#
Parameter set: Path

Parameters

Alias String[] optionalposition: namedpipeline: False
Filter by dropdown list alias (wildcards supported).
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Path to the .docx file.
Tag String[] optionalposition: namedpipeline: False
Filter by dropdown list tag (wildcards supported).

Outputs

OfficeIMO.Word.WordDropDownList

Get-OfficeWordDropDownList [-Alias <String[]>] -Document <WordDocument> [-Tag <String[]>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Alias String[] optionalposition: namedpipeline: False
Filter by dropdown list alias (wildcards supported).
Document WordDocument requiredposition: namedpipeline: True (ByValue)
Word document to read.
Tag String[] optionalposition: namedpipeline: False
Filter by dropdown list tag (wildcards supported).

Outputs

OfficeIMO.Word.WordDropDownList