Excel.CommentReplyCollection class
Representa una colección de objetos de respuesta de comentario que forman parte del comentario.
- 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(content, content |
Crea una respuesta de comentario para un comentario. |
| add(content, content |
Crea una respuesta de comentario para un comentario. |
| get |
Obtiene el número de respuestas de comentarios de la colección. |
| get |
Devuelve una respuesta de comentario identificada por su Id. |
| get |
Obtiene una respuesta comentario en función de su posición en la colección. |
| get |
Devuelve una respuesta de comentario identificada por su Id. Si el objeto de respuesta 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 |
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.CommentReply[];Valor de propiedad
Detalles del método
add(content, contentType)
Crea una respuesta de comentario para un comentario.
add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply;Parámetros
- content
-
Excel.CommentRichContent | string
Contenido del comentario. Puede ser una cadena o un CommentRichContent objeto (por ejemplo, para comentarios con 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-replies.yaml
await Excel.run(async (context) => {
// Adds a reply to the first comment in this worksheet.
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.replies.add("Add content to this worksheet.");
await context.sync();
});
add(content, contentTypeString)
Crea una respuesta de comentario para un comentario.
add(content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.CommentReply;Parámetros
- content
-
Excel.CommentRichContent | string
Contenido del comentario. Puede ser una cadena o un CommentRichContent objeto (por ejemplo, para comentarios con 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 respuestas de comentarios de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getItem(commentReplyId)
Devuelve una respuesta de comentario identificada por su Id.
getItem(commentReplyId: string): Excel.CommentReply;Parámetros
- commentReplyId
-
string
Identificador de la respuesta de comentario.
Devoluciones
Comentarios
getItemAt(index)
Obtiene una respuesta comentario en función de su posición en la colección.
getItemAt(index: number): Excel.CommentReply;Parámetros
- index
-
number
Valor de índice de la respuesta de comentario que se va a recuperar. La colección usa la indexación de base cero.
Devoluciones
Comentarios
getItemOrNullObject(commentReplyId)
Devuelve una respuesta de comentario identificada por su Id. Si el objeto de respuesta 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(commentReplyId: string): Excel.CommentReply;Parámetros
- commentReplyId
-
string
Identificador de la respuesta de 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.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection;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.CommentReplyCollection;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.CommentReplyCollection;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.CommentReplyCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.CommentReplyCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.
toJSON(): Excel.Interfaces.CommentReplyCollectionData;Devoluciones
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