Word.DocumentCompareOptions 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.

Especifica las opciones que se van a incluir en una operación de comparación de documentos.

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/compare-documents.yaml

// Compares the current document with a specified external document.
await Word.run(async (context) => {
  // Absolute path of an online or local document.
  const filePath = $("#filePath")
    .val()
    .toString();
  // Options that configure the compare operation.
  const options = {
    compareTarget: Word.CompareTarget.compareTargetCurrent,
    detectFormatChanges: false
    // Other options you choose...
    };
  context.document.compare(filePath, options);

  await context.sync();

  console.log("Differences shown in the current document.");
});

Propiedades

addToRecentFiles	True agrega el documento a la lista de archivos usados recientemente en el menú archivo. El valor predeterminado es True.
authorName	Nombre del revisor asociado con las diferencias generadas en la comparación. Si no se especifica, se toma como valor predeterminado el nombre del autor del documento revisado o la cadena "Comparison" si no hay ninguna información sobre el autor.
compareTarget	El documento de destino para la comparación. El valor predeterminado es "CompareTargetCurrent".
detectFormatChanges	Es true (valor predeterminado) para que la comparación detecte también los cambios de formato.
ignoreAllComparisonWarnings	True compara los documentos sin notificar a un usuario de problemas. El valor predeterminado es False.
removeDateAndTime	True quita la información de marca de fecha y hora de los cambios realizados en el objeto Document. El valor predeterminado es False.
removePersonalInformation	True quita toda la información del usuario de los comentarios, las revisiones y el cuadro de diálogo de propiedades del objeto Document devuelto. El valor predeterminado es False.

Detalles de las propiedades

addToRecentFiles

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.

True agrega el documento a la lista de archivos usados recientemente en el menú archivo. El valor predeterminado es True.

addToRecentFiles?: boolean;

Valor de propiedad

boolean

Comentarios

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

authorName

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.

Nombre del revisor asociado con las diferencias generadas en la comparación. Si no se especifica, se toma como valor predeterminado el nombre del autor del documento revisado o la cadena "Comparison" si no hay ninguna información sobre el autor.

authorName?: string;

Valor de propiedad

string

Comentarios

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

compareTarget

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 documento de destino para la comparación. El valor predeterminado es "CompareTargetCurrent".

compareTarget?: Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew";

Valor de propiedad

Word.CompareTarget | "CompareTargetCurrent" | "CompareTargetSelected" | "CompareTargetNew"

Comentarios

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

detectFormatChanges

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.

Es true (valor predeterminado) para que la comparación detecte también los cambios de formato.

detectFormatChanges?: boolean;

Valor de propiedad

boolean

Comentarios

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

ignoreAllComparisonWarnings

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.

True compara los documentos sin notificar a un usuario de problemas. El valor predeterminado es False.

ignoreAllComparisonWarnings?: boolean;

Valor de propiedad

boolean

Comentarios

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

removeDateAndTime

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.

True quita la información de marca de fecha y hora de los cambios realizados en el objeto Document. El valor predeterminado es False.

removeDateAndTime?: boolean;

Valor de propiedad

boolean

Comentarios

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

removePersonalInformation

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.

True quita toda la información del usuario de los comentarios, las revisiones y el cuadro de diálogo de propiedades del objeto Document devuelto. El valor predeterminado es False.

removePersonalInformation?: boolean;

Valor de propiedad

boolean

Comentarios

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