Word.ContentControlEventArgs interface

Paquete:

word

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.

Proporciona información sobre el control de contenido que generó un evento.

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Propiedades

contentControl	Objeto que generó el evento. Cargue este objeto para obtener sus propiedades.
eventType	El tipo de evento. Consulte Word.EventType para obtener más información.
ids	Obtiene los identificadores de control de contenido.
source	Origen del evento. Puede ser local o remota (a través de la coautoría).

Detalles de las propiedades

contentControl

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.

Objeto que generó el evento. Cargue este objeto para obtener sus propiedades.

contentControl: Word.ContentControl;

Valor de propiedad

Word.ContentControl

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/content-control-ondeleted-event.yaml
async function contentControlDeleted(event: Word.ContentControlEventArgs) {
  await Word.run(async (context) => {
    // Display the deleted content control's ID.
    console.log(`${event.eventType} event detected. ID of content control that was deleted: ${event.contentControl.id}`);
  });
}

eventType

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.

El tipo de evento. Consulte Word.EventType para obtener más información.

eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited";

Valor de propiedad

Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited"

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/content-control-ondeleted-event.yaml
async function contentControlDeleted(event: Word.ContentControlEventArgs) {
  await Word.run(async (context) => {
    // Display the deleted content control's ID.
    console.log(`${event.eventType} event detected. ID of content control that was deleted: ${event.contentControl.id}`);
  });
}

ids

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 los identificadores de control de contenido.

ids: number[];

Valor de propiedad

number[]

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

source

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.

Origen del evento. Puede ser local o remota (a través de la coautoría).

source: Word.EventSource | "Local" | "Remote";

Valor de propiedad

Word.EventSource | "Local" | "Remote"

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]