[office-js-preview] Clarifying Range limits when adding comments (#35697)

This commit is contained in:
Alex Jerabek
2019-05-24 09:35:51 -07:00
committed by Ryan Cavanaugh
parent 18c8f651da
commit d64ede8521
+4 -4
View File
@@ -36091,25 +36091,25 @@ declare namespace Excel {
readonly items: Excel.Comment[];
/**
*
* Creates a new comment with the given content on the given cell. An invalid argument error is thrown if the provided range is larger than one cell.
* Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*
* @param content The comment content.
* @param cellAddress The cell to which the comment is added. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name.
* @param cellAddress The cell to which the comment is added. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell.
* @param contentType Optional. The type of the comment content.
*/
add(content: string, cellAddress: Range | string, contentType?: Excel.ContentType): Excel.Comment;
/**
*
* Creates a new comment with the given content on the given cell. An invalid argument error is thrown if the provided range is larger than one cell.
* Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell.
*
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
* @beta
*
* @param content The comment content.
* @param cellAddress The cell to which the comment is added. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name.
* @param cellAddress The cell to which the comment is added. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell.
* @param contentType Optional. The type of the comment content.
*/
add(content: string, cellAddress: Range | string, contentType?: "Plain"): Excel.Comment;