Word.Comment class

  • Referencia
Paquete:
word

Representa un comentario en el documento.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: WordApi 1.4 ]

Propiedades

authorEmail

Obtiene el correo electrónico del autor del comentario.
authorName

Obtiene el nombre del autor del comentario.
content

Especifica el contenido del comentario como texto sin formato.
contentRange

Especifica el intervalo 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.
creationDate

Obtiene la fecha de creación del comentario.
id

Obtiene el identificador del comentario.
replies

Obtiene la colección de objetos de respuesta asociados al comentario.
resolved

Especifica el estado del subproceso de comentario. Si se establece en true, se resuelve el subproceso de comentario. Obtener un valor de true significa que el subproceso de comentario se resuelve.

Métodos

delete()

Elimina el comentario y sus respuestas.
getRange()

Obtiene el intervalo del documento principal en el que se encuentra el comentario.
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(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
reply(replyText)

Agrega una nueva respuesta al final del subproceso de comentario.
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 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 Word original. El objeto Comment es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.CommentData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.
untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

authorEmail

Obtiene el correo electrónico del autor del comentario.

readonly authorEmail: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.4 ]

authorName

Obtiene el nombre del autor del comentario.

readonly authorName: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.4 ]

content

Especifica el contenido del comentario como texto sin formato.

content: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.4 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Edits the first comment in the selected content.
await Word.run(async (context) => {
  const text = $("#edit-comment-text")
    .val()
    .toString();
  const comment = context.document
    .getSelection()
    .getComments()
    .getFirst();
  comment.content = text;

  // Load object for display in Script Lab console.
  comment.load();
  await context.sync();

  console.log("Comment content changed:");
  console.log(comment);
});

contentRange

Especifica el intervalo de contenido del comentario.

contentRange: Word.CommentContentRange;

Valor de propiedad

Word.CommentContentRange

Comentarios

[ Conjunto de API: WordApi 1.4 ]

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

Word.RequestContext

creationDate

Obtiene la fecha de creación del comentario.

readonly creationDate: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: WordApi 1.4 ]

id

Obtiene el identificador del comentario.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.4 ]

replies

Obtiene la colección de objetos de respuesta asociados al comentario.

readonly replies: Word.CommentReplyCollection;

Valor de propiedad

Word.CommentReplyCollection

Comentarios

[ Conjunto de API: WordApi 1.4 ]

resolved

Especifica el estado del subproceso de comentario. Si se establece en true, se resuelve el subproceso de comentario. Obtener un valor de true significa que el subproceso de comentario se resuelve.

resolved: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.4 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Toggles Resolved status of the first comment in the selected content.
await Word.run(async (context) => {
  const comment = context.document
    .getSelection()
    .getComments()
    .getFirst();
  comment.load("resolved");
  await context.sync();

  // Toggle resolved status.
  // If the comment is active, set as resolved.
  // If it's resolved, set resolved to false.
  const toggleResolved: boolean = comment.resolved;
  comment.resolved = !toggleResolved;
  comment.load();
  await context.sync();

  console.log(`Comment Resolved status: ${comment.resolved}`);
  console.log(comment);
});

Detalles del método

delete()

Elimina el comentario y sus respuestas.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.4 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Deletes the first comment in the selected content.
await Word.run(async (context) => {
  context.document
    .getSelection()
    .getComments()
    .getFirst()
    .delete();
  await context.sync();

  console.log("Comment deleted");
});

getRange()

Obtiene el intervalo del documento principal en el que se encuentra el comentario.

getRange(): Word.Range;

Devoluciones

Word.Range

Comentarios

[ Conjunto de API: WordApi 1.4 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const range = context.document
    .getSelection()
    .getComments()
    .getFirst()
    .getRange();
  range.load("text");
  await context.sync();

  console.log(`Comment location: ${range.text}`);
});

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?: Word.Interfaces.CommentLoadOptions): Word.Comment;

Parámetros

options
Word.Interfaces.CommentLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Word.Comment

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[]): Word.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

Word.Comment

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;
        }): Word.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

Word.Comment

reply(replyText)

Agrega una nueva respuesta al final del subproceso de comentario.

reply(replyText: string): Word.CommentReply;

Parámetros

replyText

string

Obligatorio. Texto de respuesta.

Devoluciones

Word.CommentReply

Comentarios

[ Conjunto de API: WordApi 1.4 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Replies to the first active comment in the selected content.
await Word.run(async (context) => {
  const text = $("#reply-text")
    .val()
    .toString();
  const comments = context.document.getSelection().getComments();
  comments.load("items");
  await context.sync();
  const firstActiveComment = comments.items.find((item) => item.resolved !== true);
  if (firstActiveComment) {
    const reply = firstActiveComment.reply(text);
    console.log("Reply added");
  } else {
    console.log("No active comment was found in the selection so couldn't reply.");
  }
});

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
Word.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: Word.Comment): void;

Parámetros

properties
Word.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 Word original. El objeto Comment es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.CommentData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.CommentData;

Devoluciones

Word.Interfaces.CommentData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.Comment;

Devoluciones

Word.Comment

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): Word.Comment;

Devoluciones

Word.Comment