Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

Stars 159
Forks 14
PowerShell Gallery downloads 158,661
Release v3.0.5
Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Add-OfficeWordCheckBox

Aliases: WordCheckBox
Namespace PSWriteOffice
Aliases
WordCheckBox
Inputs
OfficeIMO.Word.WordParagraph
Outputs
OfficeIMO.Word.WordCheckBox

Adds a checkbox content control to the current paragraph.

Remarks

Adds a checkbox content control to the current paragraph.

Examples

Authored help example

Add a checked checkbox.

PS>


Add-OfficeWordParagraph { Add-OfficeWordCheckBox -Checked -Alias 'Approved' }
        

Creates a checked checkbox content control.

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

Add-OfficeWordCheckBox [-Alias <String>] [-Checked] [-Paragraph <WordParagraph>] [-PassThru] [-Tag <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Alias String optionalposition: namedpipeline: False
Optional alias for the control.
Checked SwitchParameter optionalposition: namedpipeline: False
Set the checkbox as checked.
Paragraph WordParagraph optionalposition: namedpipeline: True (ByValue)
Explicit paragraph to receive the control.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the created control.
Tag String optionalposition: namedpipeline: False
Optional tag for the control.

Outputs

OfficeIMO.Word.WordCheckBox