API Reference

Cmdlet

Get-OfficeWordComboBox

Aliases: WordComboBoxes
Namespace PSWriteOffice
Aliases
WordComboBoxes
Inputs
OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordComboBox

Gets combo box content controls from a Word document.

Remarks

Gets combo box content controls from a Word document.

Examples

Authored help example

Example 1: Audit combo box controls in a template.

PS>


$controls = Get-OfficeWordComboBox -Path .\Template.docx -Alias 'Owner*'
            $controls |
                Select-Object -Property Alias, Tag |
                Format-Table -AutoSize
        

Filters combo box content controls so template owners can verify the expected owner fields exist.

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

Parameters

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

Outputs

OfficeIMO.Word.WordComboBox

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

Parameters

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

Outputs

OfficeIMO.Word.WordComboBox