Add-OfficeExcelComment

Aliases: ExcelComment

Namespace PSWriteOffice

Aliases

ExcelComment

Inputs

OfficeIMO.Excel.ExcelDocument

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 <Int32>] [-Initials <String>] [-PassThru] [-Row <Int32>] -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 Int32 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 Int32 optionalposition: namedpipeline: False: 1-based row index.
Text String requiredposition: namedpipeline: False: Comment text.

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

Parameters

Address String optionalposition: namedpipeline: False: A1-style cell address (e.g., A1, C5).
Author String optionalposition: namedpipeline: False: Author name (optional).
Column Int32 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 Int32 optionalposition: namedpipeline: False: 1-based row index.
Sheet String optionalposition: namedpipeline: False: Worksheet name when using Document.
SheetIndex Int32 optionalposition: namedpipeline: False: Worksheet index (0-based) when using Document.
Text String requiredposition: namedpipeline: False: Comment text.