Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

Stars 654

Forks 82

Open issues 1

Total downloads 4,320,051

Release OfficeIMO-v3.5.3

Language: C# Updated: 2026-11-03

Cmdlet

Get-OfficeWordCheckBox

Aliases: WordCheckBoxes

Module: PSWriteOffice
Aliases: WordCheckBoxes
Inputs: OfficeIMO.Word.WordDocument
Outputs: OfficeIMO.Word.WordCheckBox
Source: GetOfficeWordCheckBoxCommand.cs:24 Edit on GitHub

Gets checkbox content controls from a Word document.

Syntax

Get-OfficeWordCheckBox
[-Alias <String[]>]
[-Checked]
[-Path] <String>
[-Tag <String[]>]
[-Unchecked]
[<CommonParameters>]

Parameter set: Path

Get-OfficeWordCheckBox
[-Alias <String[]>]
[-Checked]
-Document <WordDocument>
[-Tag <String[]>]
[-Unchecked]
[<CommonParameters>]

Parameter set: Document

Examples

Review unchecked approval boxes.

$openItems = Get-OfficeWordCheckBox -Path .\Report.docx -Tag 'approval-*' -Unchecked
$openItems |
    Select-Object -Property Alias, Tag, IsChecked |
    Format-Table -AutoSize

Finds unchecked approval checkboxes by tag so a review workflow can show what is still pending.

Parameters

-Alias String[] optional: Filter by checkbox alias (wildcards supported).
-Checked SwitchParameter optional: Only return checked checkboxes.
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Path to the .docx file.
-Tag String[] optional: Filter by checkbox tag (wildcards supported).
-Unchecked SwitchParameter optional: Only return unchecked checkboxes.
-Document WordDocument requiredpipeline: True (ByValue)sets: Document: Word document to read.

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.