Excel.Comment class
Representa un comentario en el libro.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.10 ]
Propiedades
| author |
Obtiene el correo electrónico del autor del comentario. |
| author |
Obtiene el nombre del autor del comentario. |
| content | Contenido del comentario. La cadena es texto sin formato. |
| content |
Obtiene el tipo de contenido del comentario. |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| creation |
Obtiene la hora de creación del comentario. Devuelve |
| id | Especifica el identificador de comentario. |
| mentions | Obtiene las entidades (por ejemplo, personas) que se mencionan en los comentarios. |
| replies | Indica una colección de objetos de respuesta asociados con el comentario. |
| resolved | Estado del subproceso de comentario. Un valor de |
| rich |
Obtiene el contenido de comentario enriquecido (por ejemplo, las menciones en los comentarios). Esta cadena no está pensada para mostrarse a los usuarios finales. El complemento solo debe usarlo para analizar contenido de comentarios enriquecidos. |
Métodos
| assign |
Asigna la tarea adjunta al comentario al usuario especificado como usuario asignado. Si no hay ninguna tarea, se creará una. |
| delete() | Elimina el comentario y todas las respuestas conectadas. |
| get |
Obtiene la celda donde se encuentra este comentario. |
| get |
Obtiene la tarea asociada a este comentario. Si no hay ninguna tarea para el subproceso de comentario, se produce una |
| get |
Obtiene la tarea asociada a este comentario. Si no hay ninguna tarea para el subproceso de comentario, 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 |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
| toJSON() | Invalida el método JavaScript |
| update |
Novedades el contenido del comentario con una cadena con formato especial y una lista de menciones. |
Detalles de las propiedades
authorEmail
Obtiene el correo electrónico del autor del comentario.
readonly authorEmail: string;Valor de propiedad
string
Comentarios
authorName
Obtiene el nombre del autor del comentario.
readonly authorName: string;Valor de propiedad
string
Comentarios
content
Contenido del comentario. La cadena es texto sin formato.
content: string;Valor de propiedad
string
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");
const comment = sheet.comments.getItemAt(0);
comment.content = "PLEASE add headers here.";
await context.sync();
});
contentType
Obtiene el tipo de contenido del comentario.
readonly contentType: Excel.ContentType | "Plain" | "Mention";Valor de propiedad
Excel.ContentType | "Plain" | "Mention"
Comentarios
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
creationDate
Obtiene la hora de creación del comentario. Devuelve null si el comentario se ha convertido a partir de una nota, ya que el comentario no tiene una fecha de creación.
readonly creationDate: Date;Valor de propiedad
Date
Comentarios
id
Especifica el identificador de comentario.
readonly id: string;Valor de propiedad
string
Comentarios
mentions
Obtiene las entidades (por ejemplo, personas) que se mencionan en los comentarios.
readonly mentions: Excel.CommentMention[];Valor de propiedad
Comentarios
replies
Indica una colección de objetos de respuesta asociados con el comentario.
readonly replies: Excel.CommentReplyCollection;Valor de propiedad
Comentarios
resolved
Estado del subproceso de comentario. Un valor de true significa que el subproceso de comentario se resuelve.
resolved: boolean;Valor de propiedad
boolean
Comentarios
[ Conjunto de API: ExcelApi 1.11 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-resolution.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Comments");
sheet.comments.getItemAt(0).resolved = true;
await context.sync();
});
richContent
Obtiene el contenido de comentario enriquecido (por ejemplo, las menciones en los comentarios). Esta cadena no está pensada para mostrarse a los usuarios finales. El complemento solo debe usarlo para analizar contenido de comentarios enriquecidos.
readonly richContent: string;Valor de propiedad
string
Comentarios
Detalles del método
assignTask(assignee)
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Asigna la tarea adjunta al comentario al usuario especificado como usuario asignado. Si no hay ninguna tarea, se creará una.
assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;Parámetros
- assignee
- Excel.EmailIdentity
Información de identidad de usuario del usuario asignado.
Devoluciones
Comentarios
[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]
delete()
Elimina el comentario y todas las respuestas conectadas.
delete(): void;Devoluciones
void
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) => {
context.workbook.comments.getItemByCell("Comments!A2").delete();
await context.sync();
});
getLocation()
Obtiene la celda donde se encuentra este comentario.
getLocation(): Excel.Range;Devoluciones
Comentarios
getTask()
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Obtiene la tarea asociada a este comentario. Si no hay ninguna tarea para el subproceso de comentario, se produce una ItemNotFound excepción.
getTask(): Excel.DocumentTask;Devoluciones
Comentarios
[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]
getTaskOrNullObject()
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Obtiene la tarea asociada a este comentario. Si no hay ninguna tarea para el subproceso de comentario, 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).
getTaskOrNullObject(): Excel.DocumentTask;Devoluciones
Comentarios
[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]
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.CommentLoadOptions): Excel.Comment;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.Comment;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
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 comment = context.workbook.comments.getItemByCell("Comments!A2");
comment.load(["authorEmail", "authorName", "creationDate"]);
await context.sync();
console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`);
await context.sync();
});
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?: {
select?: string;
expand?: string;
}): Excel.Comment;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.CommentUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
set(properties: Excel.Comment): void;Parámetros
- properties
- Excel.Comment
Devoluciones
void
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.Comment es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.CommentData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.CommentData;Devoluciones
updateMentions(contentWithMentions)
Novedades el contenido del comentario con una cadena con formato especial y una lista de menciones.
updateMentions(contentWithMentions: Excel.CommentRichContent): void;Parámetros
- contentWithMentions
- Excel.CommentRichContent
Contenido del comentario. Contiene una cadena con formato especial y una lista de menciones que se analizarán en la cadena cuando Excel la muestre.
Devoluciones
void