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 | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el 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 genera un |
| add(cell |
Crea un nuevo comentario con el contenido específico de la celda. Se genera 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 dada. |
| 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() | Reemplaza el método JavaScript |
Eventos
| on |
Ocurre 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 |
Ocurre cuando se eliminan comentarios en la colección de comentarios. |
Detalles de las propiedades
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el 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 genera un InvalidArgument error si el rango 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 objeto o una Range cadena. Si es una cadena, debe contener la dirección completa, incluido el nombre de la hoja. Se genera un InvalidArgument error si el rango proporcionado es mayor que una celda.
- content
-
Excel.CommentRichContent | string
El contenido del comentario. Puede ser una cadena o CommentRichContent un objeto. Las cadenas se usan para texto sin formato.
CommentRichContent Los objetos permiten otras características de comentarios, como menciones. [Conjunto de API: ExcelApi 1.10 para la cadena, 1.11 para el objeto CommentRichContent]
- contentType
- Excel.ContentType
Opcional. El tipo de contenido incluido en el comentario. El valor predeterminado es enumeración ContentType.Plain. [Conjunto de API: ExcelApi 1.10 para enumeración ContentType.Plain, 1.11 para enumeración ContentType.Mention]
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.10]
add(cellAddress, content, contentType)
Crea un nuevo comentario con el contenido específico de la celda. Se genera un InvalidArgument error si el rango proporcionado es mayor que una celda.
add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.Comment;Parámetros
- cellAddress
-
Excel.Range | string
Celda a la que se agrega el comentario. Puede ser un objeto o una Range cadena. Si es una cadena, debe contener la dirección completa, incluido el nombre de la hoja. Se genera un InvalidArgument error si el rango proporcionado es mayor que una celda.
- content
-
Excel.CommentRichContent | string
El contenido del comentario. Puede ser una cadena o CommentRichContent un objeto. Las cadenas se usan para texto sin formato.
CommentRichContent Los objetos permiten otras características de comentarios, como menciones. [Conjunto de API: ExcelApi 1.10 para la cadena, 1.11 para el objeto CommentRichContent]
- contentType
-
"Plain" | "Mention"
Opcional. El tipo de contenido incluido en el comentario. El valor predeterminado es enumeración ContentType.Plain. [Conjunto de API: ExcelApi 1.10 para enumeración ContentType.Plain, 1.11 para enumeración ContentType.Mention]
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.10]
getCount()
Obtiene el número de comentarios de la colección.
getCount(): OfficeExtension.ClientResult<number>;Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
[Conjunto de API: ExcelApi 1.10]
getItem(commentId)
Obtiene un comentario de la colección en función de su identificador.
getItem(commentId: string): Excel.Comment;Parámetros
- commentId
-
string
El identificador del comentario.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.10]
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
[Conjunto de API: ExcelApi 1.10]
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 objeto o una Range cadena. Si es una cadena, debe contener la dirección completa, incluido el nombre de la hoja. Se genera un InvalidArgument error si el rango proporcionado es mayor que una celda.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.10]
getItemByReplyId(replyId)
Obtiene el comentario al que está conectada la respuesta dada.
getItemByReplyId(replyId: string): Excel.Comment;Parámetros
- replyId
-
string
El identificador de la respuesta al comentario.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.10]
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 los métodos y propiedades *OrNullObject.
getItemOrNullObject(commentId: string): Excel.Comment;Parámetros
- commentId
-
string
El identificador del comentario.
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.14]
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()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.CommentCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.CommentCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.
toJSON(): Excel.Interfaces.CommentCollectionData;Devoluciones
Detalles del evento
onAdded
Ocurre cuando se agregan los comentarios.
readonly onAdded: OfficeExtension.EventHandlers<Excel.CommentAddedEventArgs>;Tipo de evento
Comentarios
[Conjunto de API: ExcelApi 1.12]
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]
onDeleted
Ocurre cuando se eliminan comentarios en la colección de comentarios.
readonly onDeleted: OfficeExtension.EventHandlers<Excel.CommentDeletedEventArgs>;Tipo de evento
Comentarios
[Conjunto de API: ExcelApi 1.12]