OfficeIMO

API Reference

Command

Get-OfficeWordCheckBox

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

Gets checkbox content controls from a Word document.

Remarks

Gets checkbox content controls from a Word document.

Examples

List all checkboxes.


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

Returns all checkbox content controls 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-OfficeWordCheckBox [-Alias <String[]>] [-Checked] -InputPath <String> [-Tag <String[]>] [-Unchecked] [<CommonParameters>]
#
Parameter set: Path

Parameters

Alias String[] optionalposition: namedpipeline: False
Filter by checkbox alias (wildcards supported).
Checked SwitchParameter optionalposition: namedpipeline: False
Only return checked checkboxes.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Path to the .docx file.
Tag String[] optionalposition: namedpipeline: False
Filter by checkbox tag (wildcards supported).
Unchecked SwitchParameter optionalposition: namedpipeline: False
Only return unchecked checkboxes.

Outputs

OfficeIMO.Word.WordCheckBox

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

Parameters

Alias String[] optionalposition: namedpipeline: False
Filter by checkbox alias (wildcards supported).
Checked SwitchParameter optionalposition: namedpipeline: False
Only return checked checkboxes.
Document WordDocument requiredposition: namedpipeline: True (ByValue)
Word document to read.
Tag String[] optionalposition: namedpipeline: False
Filter by checkbox tag (wildcards supported).
Unchecked SwitchParameter optionalposition: namedpipeline: False
Only return unchecked checkboxes.

Outputs

OfficeIMO.Word.WordCheckBox