Cmdlet
Remove-OfficeExcelComment
Removes a comment (note) from a worksheet cell.
Syntax
Remove-OfficeExcelComment
[-Address <String>]
[-Column <Int32>]
[-PassThru]
[-Row <Int32>]
[<CommonParameters>]#Parameter set:
ContextRemove-OfficeExcelComment
[-Address <String>]
[-Column <Int32>]
-Document <ExcelDocument>
[-PassThru]
[-Row <Int32>]
[-Sheet <String>]
[-SheetIndex <Int32>]
[<CommonParameters>]#Parameter set:
DocumentExamples
Remove a comment from B2.
ExcelSheet 'Data' { Remove-OfficeExcelComment -Address 'B2' }Clears the comment from cell B2.
Parameters
- -Address String
- A1-style cell address (e.g., A1, C5).
- -Column Int32
- 1-based column index.
- -PassThru SwitchParameter
- Emit the worksheet after removing the comment.
- -Row Int32
- 1-based row index.
- -Document ExcelDocument
- Workbook to operate on outside the DSL context.
- -Sheet String
- Worksheet name when using Document.
- -SheetIndex Int32
- 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.