Evotec

Project

PSWriteOffice

PSWriteOffice is an open-source PowerShell and .NET project with packages, release history, and technical documentation.

View on GitHub Releases Get package
Stars 144
Forks 12
Open issues 16
PowerShell Gallery downloads 150,904
Release v0.2.0
Language: C# Updated: 2026-04-06

API Reference

Cmdlet

Add-OfficeExcelComment

Namespace PSWriteOffice
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Object
Source
Sources/PSWriteOffice/Cmdlets/Excel/AddOfficeExcelCommentCommand.cs:17 Edit on GitHub

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

Remarks

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

Examples

Authored help example

Add a comment to A1.

PS>


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

Creates a cell comment at A1.

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-OfficeExcelComment [-Address <String>] [-Author <String>] [-Column <Nullable`1>] [-Initials <String>] [-PassThru] [-Row <Nullable`1>] -Text <String> [<CommonParameters>]
#
Parameter set: Context

Parameters

Address String optionalposition: namedpipeline: False
A1-style cell address (e.g., A1, C5).
Author String optionalposition: namedpipeline: False
Author name (optional).
Column Nullable`1 optionalposition: namedpipeline: False
1-based column index.
Initials String optionalposition: namedpipeline: False
Author initials (optional).
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the worksheet after adding the comment.
Row Nullable`1 optionalposition: namedpipeline: False
1-based row index.
Text String requiredposition: namedpipeline: False
Comment text.

Outputs

System.Object

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

Parameters

Address String optionalposition: namedpipeline: False
A1-style cell address (e.g., A1, C5).
Author String optionalposition: namedpipeline: False
Author name (optional).
Column Nullable`1 optionalposition: namedpipeline: False
1-based column index.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to operate on outside the DSL context.
Initials String optionalposition: namedpipeline: False
Author initials (optional).
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the worksheet after adding the comment.
Row Nullable`1 optionalposition: namedpipeline: False
1-based row index.
Sheet String optionalposition: namedpipeline: False
Worksheet name when using Document.
SheetIndex Nullable`1 optionalposition: namedpipeline: False
Worksheet index (0-based) when using Document.
Text String requiredposition: namedpipeline: False
Comment text.

Outputs

System.Object