Project

PSWriteOffice

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

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Add-OfficeExcelComment

Aliases: ExcelComment
Module
PSWriteOffice
Aliases
ExcelComment
Inputs
OfficeIMO.Excel.ExcelDocument
Source
AddOfficeExcelCommentCommand.cs:17 Edit on GitHub

Adds or replaces a comment (note) on a worksheet cell.

Syntax

Add-OfficeExcelComment
[-Address <String>]
[-Author <String>]
[-Column <Int32>]
[-Initials <String>]
[-PassThru]
[-Row <Int32>]
-Text <String>
[<CommonParameters>]
#
Parameter set: Context
Add-OfficeExcelComment
[-Address <String>]
[-Author <String>]
[-Column <Int32>]
-Document <ExcelDocument>
[-Initials <String>]
[-PassThru]
[-Row <Int32>]
[-Sheet <String>]
[-SheetIndex <Int32>]
-Text <String>
[<CommonParameters>]
#
Parameter set: Document

Examples

Add a comment to A1.

ExcelSheet 'Data' { Add-OfficeExcelComment -Address 'A1' -Text 'Review this cell' }

Creates a cell comment at A1.

Parameters

-Address String optional
A1-style cell address (e.g., A1, C5).
-Author String optional
Author name (optional).
-Column Int32 optional
1-based column index.
-Initials String optional
Author initials (optional).
-PassThru SwitchParameter optional
Emit the worksheet after adding the comment.
-Row Int32 optional
1-based row index.
-Text String required
Comment text.
-Document ExcelDocument requiredpipeline: True (ByValue)sets: Document
Workbook to operate on outside the DSL context.
-Sheet String optionalsets: Document
Worksheet name when using Document.
-SheetIndex Int32 optionalsets: Document
Worksheet index (0-based) when using 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.