Compartilhar via

Word.Page class

Pacote:
word

Representa uma página no documento. Page os objetos gerem o esquema e o conteúdo da página.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: 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);
  }
});

Propriedades

breaks

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

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
height

Obtém a altura, em pontos, do papel definido na caixa de diálogo Configurar Página.
index

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

Obtém a largura, em pontos, do papel definido na caixa de diálogo Configurar Página.

Métodos

getNext()

Obtém a página seguinte no painel. Gera um ItemNotFound erro se esta página for a última.
getNextOrNullObject()

Obtém a página seguinte. Se esta página for a última, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getRange(rangeLocation)

Obtém a página inteira, ou o ponto inicial ou final da página, como um intervalo.
load(options)

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

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

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

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Page é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.PageData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

Detalhes da propriedade

breaks

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

readonly breaks: Word.BreakCollection;

Valor da propriedade

Word.BreakCollection

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

height

Obtém a altura, em pontos, do papel definido na caixa de diálogo Configurar Página.

readonly height: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

index

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

readonly index: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: 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);
  }
});

width

Obtém a largura, em pontos, do papel definido na caixa de diálogo Configurar Página.

readonly width: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

Detalhes do método

getNext()

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

getNext(): Word.Page;

Retornos

Word.Page

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

getNextOrNullObject()

Obtém a página seguinte. Se esta página for a última, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getNextOrNullObject(): Word.Page;

Retornos

Word.Page

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

getRange(rangeLocation)

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

rangeLocation

whole | start | end | "Whole" | "Start" | "End"

Opcional. A localização do intervalo tem de ser whole, startou end.

Retornos

Word.Range

Comentários

[ Conjunto de API: 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);
  }
});

load(options)

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

options
Word.Interfaces.PageLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Word.Page

load(propertyNames)

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

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Word.Page

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Word.Page

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Page é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.PageData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.PageData;

Retornos

Word.Interfaces.PageData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.Page;

Retornos

Word.Page

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.Page;

Retornos

Word.Page