Word.Page class

Obtient un BreakCollection objet qui représente les sauts sur la page.

readonly breaks: Word.BreakCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Exemples

// 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}.`);
  });
});

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient la hauteur, en points, du papier défini dans la boîte de dialogue Mise en page.

readonly height: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Obtient l’index de la page. L’index de page est basé sur 1 et indépendant de la numérotation des pages personnalisée de l’utilisateur.

readonly index: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

// 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}`);
  });
});

Obtient la largeur, en points, du papier défini dans la boîte de dialogue Mise en page.

readonly width: number;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.2

Atteint la page suivante dans le volet. Génère une ItemNotFound erreur si cette page est la dernière.

getNext(): Word.Page;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

// 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}`);
});

Ouvre la page suivante. Si cette page est la dernière, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getNextOrNullObject(): Word.Page;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

// 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.");
});

Récupère la page entière, ou le point de début ou de fin de la page, sous la forme d’une plage.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.2

Exemples

// 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}`);
  }
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.PageLoadOptions): Word.Page;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.Page;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Page;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.Page est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.PageDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.PageData;

Retours

Exemples

// 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);
});

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Page;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Word.Page;

Retours