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

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/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the pages that contain the third paragraph.
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load();
  await context.sync();

  const paraThree = paragraphs.items[2];
  const rangeOfParagraph = paraThree.getRange();
  const pages: Word.PageCollection = rangeOfParagraph.pages;
  pages.load();
  await context.sync();

  // Log info for pages in range.
  console.log(pages);
  const pagesIndexes = [];
  const pagesText = [];
  for (let i = 0; i < pages.items.length; i++) {
    const page = pages.items[i];
    page.load("index");
    pagesIndexes.push(page);

    const range = page.getRange();
    range.load("text");
    pagesText.push(range);
  }

  await context.sync();

  for (let i = 0; i < pagesIndexes.length; i++) {
    console.log(`Index of page ${i + 1} that contains the third paragraph: ${pagesIndexes[i].index}`);
    console.log("Text of that page:", pagesText[i].text);
  }
});

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

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

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/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets pages of the selection.
  const pages: Word.PageCollection = context.document.getSelection().pages;
  pages.load();
  await context.sync();

  // Log info for pages included in selection.
  console.log(pages);
  const pagesIndexes = [];
  const pagesText = [];
  for (let i = 0; i < pages.items.length; i++) {
    const page = pages.items[i];
    page.load("index");
    pagesIndexes.push(page);

    const range = page.getRange();
    range.load("text");
    pagesText.push(range);
  }

  await context.sync();

  for (let i = 0; i < pagesIndexes.length; i++) {
    console.log(`Index info for page ${i + 1} in the selection: ${pagesIndexes[i].index}`);
    console.log("Text of that page in the selection:", pagesText[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

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