Word.Revision class

Obtiene el nombre del usuario que realizó el control de cambios.

readonly author: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.4

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

Obtiene la fecha y hora en que se realizó el control de cambios.

readonly date: Date;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.4

Obtiene la descripción de los cambios de formato realizados en la revisión.

readonly formatDescription: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.4

Obtiene un número que representa la posición de este elemento en una colección.

readonly index: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.4

Obtiene un Range objeto que representa el rango de texto que se movió de un lugar a otro en el documento con seguimiento de cambios.

readonly movedRange: Word.Range;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.4

Ejemplos

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

// Reads and selects the text associated with a tracked move.
await Word.run(async (context) => {
    const document: Word.Document = context.document;
    const revisions: Word.RevisionCollection = document.revisions;
    revisions.load("items/type");
    await context.sync();

    const movedFrom: Word.RevisionType = Word.RevisionType.movedFrom;
    const movedTo: Word.RevisionType = Word.RevisionType.movedTo;
    const movedRevision: Word.Revision | undefined = revisions.items.find(
        (revision: Word.Revision) => revision.type === movedFrom || revision.type === movedTo
    );
    if (!movedRevision) {
        console.log("Revision types found:", revisions.items.map((revision: Word.Revision) => revision.type));
        console.warn("No tracked move was found. Move an entire paragraph as described in the task pane; moving a phrase may produce insertion and deletion revisions instead.");
        return;
    }

    const movedRange: Word.Range = movedRevision.movedRange;
    movedRange.load("text");
    movedRange.select();
    await context.sync();

    console.log(`Moved revision range text: ${movedRange.text}`);
});

Obtiene un Range objeto que representa la parte del documento contenida dentro de una marca de revisión.

readonly range: Word.Range;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.4

Ejemplos

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

// Reads and selects the text affected by the first revision.
await Word.run(async (context) => {
    const paragraphRange: Word.Range = context.document.body.paragraphs.getFirst().getRange();
    const revisions: Word.RevisionCollection = paragraphRange.revisions;
    revisions.load("items");
    await context.sync();

    if (revisions.items.length === 0) {
        console.warn("No revisions were found. Run Set up to create tracked changes.");
        return;
    }

    const firstRevision: Word.Revision = revisions.items[0];
    const revisionRange: Word.Range = firstRevision.range;
    revisionRange.load("text");
    revisionRange.select();
    await context.sync();

    console.log(`First revision range text: ${revisionRange.text}`);
});

Obtiene el tipo de revisión.

readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete";

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.4

Acepta la marca de revisión, quita la marca de revisión e incorpora el cambio en el documento.

accept(): void;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.4

Ejemplos

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

// Incorporates the first revision into the document.
await Word.run(async (context) => {
    const paragraphRange: Word.Range = context.document.body.paragraphs.getFirst().getRange();
    const revisions: Word.RevisionCollection = paragraphRange.revisions;
    revisions.load("items");
    await context.sync();

    if (revisions.items.length === 0) {
        console.warn("No revisions were found. Run Set up to create tracked changes.");
        return;
    }

    const firstRevision: Word.Revision = revisions.items[0];
    firstRevision.accept();
    await context.sync();

    console.log("Accepted the first revision. Get revision metadata to inspect the remaining revisions.");
});

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

Parámetros

Devoluciones

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.Revision;

Parámetros

Devoluciones

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.Revision;

Parámetros

Devoluciones

Rechaza el control de cambios. Se quitan las marcas de revisión, dejando el texto original intacto.

reject(): void;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.4

Ejemplos

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

// Removes the first revision and restores the original content.
await Word.run(async (context) => {
    const paragraphRange: Word.Range = context.document.body.paragraphs.getFirst().getRange();
    const revisions: Word.RevisionCollection = paragraphRange.revisions;
    revisions.load("items");
    await context.sync();

    if (revisions.items.length === 0) {
        console.warn("No revisions were found. Run Set up to create tracked changes.");
        return;
    }

    const firstRevision: Word.Revision = revisions.items[0];
    firstRevision.reject();
    await context.sync();

    console.log("Rejected the first revision. Get revision metadata to inspect the remaining revisions.");
});

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.

set(properties: Interfaces.RevisionUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Word.Revision): void;

Parámetros

Devoluciones

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 Word.Revision es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.RevisionData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Word.Interfaces.RevisionData;

Devoluciones

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe 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 objeto 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.Revision;

Devoluciones

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de 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. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.

untrack(): Word.Revision;

Devoluciones