Поделиться через

Word.Page class

Пакет:
word

Представляет страницу в документе. Page объекты управляют макетом страницы и содержимым.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Примеры

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

Свойства

breaks

BreakCollection Возвращает объект , представляющий разрывы на странице.
context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
height

Возвращает высоту (в пунктах) бумаги, определенной в диалоговом окне Настройка страницы.
index

Возвращает индекс страницы. Индекс страницы основан на 1 и не зависит от пользовательской нумерации страниц пользователя.
width

Возвращает ширину (в пунктах) бумаги, определенной в диалоговом окне Настройка страницы.

Методы

getNext()

Возвращает следующую страницу в области. Выдает ошибку, ItemNotFound если эта страница является последней.
getNextOrNullObject()

Возвращает следующую страницу. Если эта страница является последней, то этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRange(rangeLocation)

Возвращает всю страницу или начальную или конечную точку страницы в виде диапазона.
load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Page объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.PageData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

Сведения о свойстве

breaks

BreakCollection Возвращает объект , представляющий разрывы на странице.

readonly breaks: Word.BreakCollection;

Значение свойства

Word.BreakCollection

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

height

Возвращает высоту (в пунктах) бумаги, определенной в диалоговом окне Настройка страницы.

readonly height: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

index

Возвращает индекс страницы. Индекс страницы основан на 1 и не зависит от пользовательской нумерации страниц пользователя.

readonly index: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Примеры

// 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

Возвращает ширину (в пунктах) бумаги, определенной в диалоговом окне Настройка страницы.

readonly width: number;

Значение свойства

number

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Сведения о методе

getNext()

Возвращает следующую страницу в области. Выдает ошибку, ItemNotFound если эта страница является последней.

getNext(): Word.Page;

Возвращаемое значение

Word.Page

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

getNextOrNullObject()

Возвращает следующую страницу. Если эта страница является последней, то этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getNextOrNullObject(): Word.Page;

Возвращаемое значение

Word.Page

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

getRange(rangeLocation)

Возвращает всю страницу или начальную или конечную точку страницы в виде диапазона.

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

Параметры

rangeLocation

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

Необязательный параметр. Расположение диапазона должно быть whole, startили end.

Возвращаемое значение

Word.Range

Комментарии

[ Набор API: WordApiDesktop 1.2 ]

Примеры

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

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

options
Word.Interfaces.PageLoadOptions

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

Word.Page

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Word.Page

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Word.Page

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Page объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.PageData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.PageData;

Возвращаемое значение

Word.Interfaces.PageData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.Page;

Возвращаемое значение

Word.Page

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.Page;

Возвращаемое значение

Word.Page