Word.Page class

Obtiene un BreakCollection objeto que representa los saltos en la página.

readonly breaks: Word.BreakCollection;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/36-pages/get-pages.yaml

// Gets the page number of every break in the active document pane.
await Word.run(async (context) => {
  const pages: Word.PageCollection = context.document.activeWindow.activePane.pages;
  pages.load("items");
  await context.sync();

  const breakCollections: Word.BreakCollection[] = [];
  pages.items.forEach((page: Word.Page) => {
    const breaks: Word.BreakCollection = page.breaks;
    breaks.load("items/pageIndex");
    breakCollections.push(breaks);
  });

  await context.sync();

  const documentBreaks: Word.Break[] = breakCollections.flatMap((breaks) => breaks.items);
  console.log(`Breaks found: ${documentBreaks.length}`);
  documentBreaks.forEach((documentBreak: Word.Break) => {
    console.log(`Break on page ${documentBreak.pageIndex}.`);
  });
});

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 altura, en puntos, del papel definida en el cuadro de diálogo Configurar página.

readonly height: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.2

Obtiene el índice de la página. El índice de página se basa en 1 y es independiente de la numeración de páginas personalizada del usuario.

readonly index: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.2

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/36-pages/get-pages.yaml

// Reads the page indexes for the third paragraph.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("items");
  await context.sync();

  if (paragraphs.items.length < 3) {
    console.warn("Run Set up to create at least three paragraphs.");
    return;
  }

  const thirdParagraph: Word.Paragraph = paragraphs.items[2];
  const rangeOfParagraph: Word.Range = thirdParagraph.getRange();
  const pages: Word.PageCollection = rangeOfParagraph.pages;
  pages.load("items/index");
  await context.sync();

  console.log(`Pages containing the third paragraph: ${pages.items.length}`);
  pages.items.forEach((page: Word.Page) => {
    console.log(`Page index: ${page.index}`);
  });
});

Obtiene el ancho, en puntos, del papel definido en el cuadro de diálogo Configurar página.

readonly width: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.2

Obtiene la página siguiente en el panel. Genera un ItemNotFound error si esta página es la última.

getNext(): Word.Page;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.2

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/36-pages/get-pages.yaml

// Reads the page following the first page when the document has multiple pages.
await Word.run(async (context) => {
  const pages: Word.PageCollection = context.document.activeWindow.activePane.pages;
  pages.load("items");
  await context.sync();

  if (pages.items.length < 2) {
    console.warn("Run Set up to create multiple pages before getting the next page.");
    return;
  }

  const firstPage: Word.Page = pages.getFirst();
  const nextPage: Word.Page = firstPage.getNext();
  nextPage.load("index");
  const nextPageRange: Word.Range = nextPage.getRange();
  nextPageRange.load("text");
  await context.sync();

  console.log(`Next page index: ${nextPage.index}`);
  console.log(`Next page text: ${nextPageRange.text}`);
});

Obtiene la página siguiente. Si esta página es la última, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getNextOrNullObject(): Word.Page;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.2

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/36-pages/iterate-pages.yaml

// Visits each page and stops safely when there is no next page.
await Word.run(async (context) => {
    const pages: Word.PageCollection = context.document.activeWindow.activePane.pages;
    let currentPage: Word.Page = pages.getFirstOrNullObject();
    await context.sync();

    while (!currentPage.isNullObject) {
        currentPage.load("index");
        const pageRange: Word.Range = currentPage.getRange();
        pageRange.load("text");
        await context.sync();

        console.log(`Page ${currentPage.index} text: ${pageRange.text}`);
        currentPage = currentPage.getNextOrNullObject();
        await context.sync();
    }

    console.log("Reached the end of the pages in the active pane.");
});

Obtiene toda la página, o el punto inicial o final de la página, como un rango.

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.2

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/36-pages/get-pages.yaml

// Reads the index and text of each page intersecting the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  const pages: Word.PageCollection = selectedRange.pages;
  pages.load("items/index");
  await context.sync();

  console.log(`Pages in the selection: ${pages.items.length}`);
  const pageRanges: Word.Range[] = [];
  pages.items.forEach((page: Word.Page) => {
    const pageRange: Word.Range = page.getRange(Word.RangeLocation.whole);
    pageRange.load("text");
    pageRanges.push(pageRange);
  });

  await context.sync();

  for (let i = 0; i < pages.items.length; i++) {
    console.log(`Page ${pages.items[i].index} text: ${pageRanges[i].text}`);
  }
});

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

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

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

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

toJSON(): Word.Interfaces.PageData;

Devoluciones

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/36-pages/get-pages.yaml

// Copies the first page's loaded properties into a plain JavaScript object.
await Word.run(async (context) => {
  const firstPage: Word.Page = context.document.activeWindow.activePane.pages.getFirst();
  firstPage.load("index,height,width");
  await context.sync();

  const pageData: Word.Interfaces.PageData = firstPage.toJSON();
  console.log("First page data:", pageData);
});

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

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

Devoluciones