Word.Page class

Obtém um BreakCollection objeto que representa as quebras na página.

readonly breaks: Word.BreakCollection;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Obtém a altura, em pontos, do papel definido na caixa de diálogo Configuração de página.

readonly height: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Obtém o índice da página. O índice de página é baseado em 1 e independente da numeração de página personalizada do usuário.

readonly index: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Exemplos

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

Obtém a largura, em pontos, do papel definido na caixa de diálogo Configuração de página.

readonly width: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Obtém a próxima página no painel. Gera um ItemNotFound erro se esta página for a última.

getNext(): Word.Page;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Obtém a próxima página. Se esta página for a última, então este método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getNextOrNullObject(): Word.Page;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Obtém a página inteira ou o ponto inicial ou final da página como um intervalo.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Exemplos

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

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.Page é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.PageData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.PageData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.Page;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.Page;

Retornos