Excel.CommentCollection class
Representa una colección de objetos de comentario que forman parte del libro.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.10 ]
Propiedades
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| add(cell |
Crea un nuevo comentario con el contenido específico de la celda. Se produce un |
| add(cell |
Crea un nuevo comentario con el contenido específico de la celda. Se produce un |
| get |
Obtiene el número de comentarios de la colección. |
| get |
Obtiene un comentario de la colección en función de su identificador. |
| get |
Obtiene un comentario de la colección en función de su posición. |
| get |
Obtiene el comentario de la celda especificada. Si no hay ningún comentario en la celda, se produce un error. |
| get |
Obtiene el comentario al que está conectada la respuesta especificada. |
| get |
Obtiene un comentario de la colección en función de su identificador. Si el objeto de comentario no existe, este método devuelve un objeto con su |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| toJSON() | Invalida el método JavaScript |
Eventos
| on |
Se produce cuando se agregan los comentarios. |
| on |
Se produce cuando se cambian los comentarios o las respuestas de una colección de comentarios, incluso cuando se eliminan las respuestas. |
| on |
Se produce cuando los comentarios se eliminan en la colección de comentarios. |
Detalles de las propiedades
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Excel.Comment[];Valor de propiedad
Detalles del método
add(cellAddress, content, contentType)
Crea un nuevo comentario con el contenido específico de la celda. Se produce un InvalidArgument error si el intervalo proporcionado es mayor que una celda.
add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment;Parámetros
- cellAddress
-
Excel.Range | string
Celda a la que se agrega el comentario. Puede ser un Range objeto o una cadena. Si es una cadena, debe contener la dirección completa, incluido el nombre de la hoja. Se produce un InvalidArgument error si el intervalo proporcionado es mayor que una celda.
- content
-
Excel.CommentRichContent | string
Contenido del comentario. Puede ser una cadena o CommentRichContent un objeto. Las cadenas se usan para el texto sin formato. CommentRichContent los objetos permiten otras características de comentario, como menciones. [Conjunto de api: ExcelApi 1.10 para la cadena, 1.11 para el objeto CommentRichContent]
- contentType
- Excel.ContentType
Opcional. Tipo de contenido contenido en el comentario. El valor predeterminado es enum ContentType.Plain. [Conjunto de api: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum ContentType.Mention]
Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.10 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
// Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`.
sheet.comments.add("A2", "TODO: add data.");
await context.sync();
});
add(cellAddress, content, contentTypeString)
Crea un nuevo comentario con el contenido específico de la celda. Se produce un InvalidArgument error si el intervalo proporcionado es mayor que una celda.
add(cellAddress: Range | string, content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.Comment;Parámetros
- cellAddress
-
Excel.Range | string
Celda a la que se agrega el comentario. Puede ser un Range objeto o una cadena. Si es una cadena, debe contener la dirección completa, incluido el nombre de la hoja. Se produce un InvalidArgument error si el intervalo proporcionado es mayor que una celda.
- content
-
Excel.CommentRichContent | string
Contenido del comentario. Puede ser una cadena o CommentRichContent un objeto. Las cadenas se usan para el texto sin formato. CommentRichContent los objetos permiten otras características de comentario, como menciones. [Conjunto de api: ExcelApi 1.10 para la cadena, 1.11 para el objeto CommentRichContent]
- contentTypeString
-
"Plain" | "Mention"
Opcional. Tipo de contenido contenido en el comentario. El valor predeterminado es enum ContentType.Plain. [Conjunto de api: ExcelApi 1.10 for Enum ContentType.Plain, 1.11 for Enum ContentType.Mention]
Devoluciones
Comentarios
getCount()
Obtiene el número de comentarios de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getItem(commentId)
Obtiene un comentario de la colección en función de su identificador.
getItem(commentId: string): Excel.Comment;Parámetros
- commentId
-
string
Identificador del comentario.
Devoluciones
Comentarios
getItemAt(index)
Obtiene un comentario de la colección en función de su posición.
getItemAt(index: number): Excel.Comment;Parámetros
- index
-
number
Valor de índice del objeto que se va a recuperar. Indizado con cero.
Devoluciones
Comentarios
getItemByCell(cellAddress)
Obtiene el comentario de la celda especificada. Si no hay ningún comentario en la celda, se produce un error.
getItemByCell(cellAddress: Range | string): Excel.Comment;Parámetros
- cellAddress
-
Excel.Range | string
Celda en la que se encuentra el comentario. Puede ser un Range objeto o una cadena. Si es una cadena, debe contener la dirección completa, incluido el nombre de la hoja. Se produce un InvalidArgument error si el intervalo proporcionado es mayor que una celda.
Devoluciones
Comentarios
getItemByReplyId(replyId)
Obtiene el comentario al que está conectada la respuesta especificada.
getItemByReplyId(replyId: string): Excel.Comment;Parámetros
- replyId
-
string
Identificador de la respuesta de comentario.
Devoluciones
Comentarios
getItemOrNullObject(commentId)
Obtiene un comentario de la colección en función de su identificador. Si el objeto de comentario no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getItemOrNullObject(commentId: string): Excel.Comment;Parámetros
- commentId
-
string
Identificador del comentario.
Devoluciones
Comentarios
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Excel.Interfaces.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Excel.CommentCollection;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentCollection;Parámetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
toJSON()
Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.CommentCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.CommentCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): Excel.Interfaces.CommentCollectionData;Devoluciones
Detalles del evento
onAdded
Se produce cuando se agregan los comentarios.
readonly onAdded: OfficeExtension.EventHandlers<Excel.CommentAddedEventArgs>;Tipo de evento
Comentarios
[ Conjunto de API: ExcelApi 1.12 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml
await Excel.run(async (context) => {
const comments = context.workbook.worksheets.getActiveWorksheet().comments;
// Register the onAdded, onChanged, and onDeleted comment event handlers.
comments.onAdded.add(commentAdded);
comments.onChanged.add(commentChanged);
comments.onDeleted.add(commentDeleted);
await context.sync();
console.log("Added event handlers for when comments are added, changed, or deleted.");
});
...
async function commentAdded(event: Excel.CommentAddedEventArgs) {
// Retrieve the added comment using the comment ID.
// Note: This function assumes only a single comment is added at a time.
await Excel.run(async (context) => {
const addedComment = context.workbook.comments.getItem(event.commentDetails[0].commentId);
// Load the added comment's data.
addedComment.load(["content", "authorName", "creationDate"]);
await context.sync();
// Print out the added comment's data.
console.log(`A comment was added:`);
console.log(` ID: ${event.commentDetails[0].commentId}`);
console.log(` Comment content:${addedComment.content}`);
console.log(` Comment author:${addedComment.authorName}`);
console.log(` Creation date:${addedComment.creationDate}`);
});
}
onChanged
Se produce cuando se cambian los comentarios o las respuestas de una colección de comentarios, incluso cuando se eliminan las respuestas.
readonly onChanged: OfficeExtension.EventHandlers<Excel.CommentChangedEventArgs>;Tipo de evento
Comentarios
[ Conjunto de API: ExcelApi 1.12 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml
await Excel.run(async (context) => {
const comments = context.workbook.worksheets.getActiveWorksheet().comments;
// Register the onAdded, onChanged, and onDeleted comment event handlers.
comments.onAdded.add(commentAdded);
comments.onChanged.add(commentChanged);
comments.onDeleted.add(commentDeleted);
await context.sync();
console.log("Added event handlers for when comments are added, changed, or deleted.");
});
...
async function commentChanged(event: Excel.CommentChangedEventArgs) {
// Retrieve the changed comment using the comment ID.
// Note: This function assumes only a single comment is changed at a time.
await Excel.run(async (context) => {
const changedComment = context.workbook.comments.getItem(event.commentDetails[0].commentId);
// Load the changed comment's data.
changedComment.load(["content", "authorName", "creationDate"]);
await context.sync();
// Print out the changed comment's data.
console.log(`A comment was changed:`);
console.log(` ID: ${event.commentDetails[0].commentId}`);
console.log(` Updated comment content: ${changedComment.content}`);
console.log(` Comment author: ${changedComment.authorName}`);
console.log(` Creation date: ${changedComment.creationDate}`);
});
}
onDeleted
Se produce cuando los comentarios se eliminan en la colección de comentarios.
readonly onDeleted: OfficeExtension.EventHandlers<Excel.CommentDeletedEventArgs>;Tipo de evento
Comentarios
[ Conjunto de API: ExcelApi 1.12 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml
await Excel.run(async (context) => {
const comments = context.workbook.worksheets.getActiveWorksheet().comments;
// Register the onAdded, onChanged, and onDeleted comment event handlers.
comments.onAdded.add(commentAdded);
comments.onChanged.add(commentChanged);
comments.onDeleted.add(commentDeleted);
await context.sync();
console.log("Added event handlers for when comments are added, changed, or deleted.");
});
...
async function commentDeleted(event: Excel.CommentDeletedEventArgs) {
// Print out the deleted comment's ID.
// Note: This function assumes only a single comment is deleted at a time.
await Excel.run(async (context) => {
console.log(`A comment was deleted:`);
console.log(` ID: ${event.commentDetails[0].commentId}`);
});
}
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de