OfficeIMO

API Reference

Command

Remove-OfficeExcelComment

Namespace PSWriteOffice
Inputs
OfficeIMO.Excel.ExcelDocument
Outputs
System.Object

Removes a comment (note) from a worksheet cell.

Remarks

Removes a comment (note) from a worksheet cell.

Examples

Remove a comment from B2.


PS>ExcelSheet 'Data' { Remove-OfficeExcelComment -Address 'B2' }

Clears the comment from cell B2.

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

Remove-OfficeExcelComment [-Address <String>] [-Column <Nullable`1>] [-PassThru] [-Row <Nullable`1>] [<CommonParameters>]
#
Parameter set: Context

Parameters

Address String optionalposition: namedpipeline: False
A1-style cell address (e.g., A1, C5).
Column Nullable`1 optionalposition: namedpipeline: False
1-based column index.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the worksheet after removing the comment.
Row Nullable`1 optionalposition: namedpipeline: False
1-based row index.

Outputs

System.Object

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

Parameters

Address String optionalposition: namedpipeline: False
A1-style cell address (e.g., A1, C5).
Column Nullable`1 optionalposition: namedpipeline: False
1-based column index.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue)
Workbook to operate on outside the DSL context.
PassThru SwitchParameter optionalposition: namedpipeline: False
Emit the worksheet after removing 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.

Outputs

System.Object