Word.ParagraphCollection class

Пакет:

word

Содержит коллекцию Word. Объекты абзаца.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApi 1.1 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml

// Inserts an image anchored to the last paragraph.
await Word.run(async (context) => {
  context.document.body.paragraphs
    .getLast()
    .insertParagraph("", "After")
    .insertInlinePictureFromBase64(base64Image, "End");

  await context.sync();
});

Свойства

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

Методы

add(range)	Paragraph Возвращает объект , представляющий новый пустой абзац, добавленный в документ.
closeUp()	Удаляет все интервалы перед указанными абзацами.
decreaseSpacing()	Уменьшает интервалы до и после абзацев с шагом в шесть пунктов.
getFirst()	Возвращает первый абзац в коллекции. Выдает ошибку ItemNotFound , если коллекция пуста.
getFirstOrNullObject()	Возвращает первый абзац в коллекции. Если коллекция пуста, то этот метод вернет объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getLast()	Возвращает последний абзац в коллекции. Выдает ошибку ItemNotFound , если коллекция пуста.
getLastOrNullObject()	Возвращает последний абзац в коллекции. Если коллекция пуста, то этот метод вернет объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
increaseSpacing()	Увеличивает интервалы до и после абзацев с шагом в шесть пунктов.
indent()	Отступы абзацев на один уровень.
indentCharacterWidth(count)	Отступы абзацев в коллекции на указанное количество символов.
indentFirstLineCharacterWidth(count)	Отступ первой строки абзацев в коллекции на указанное количество символов.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
openOrCloseUp()	Переключает интервалы перед абзацами.
openUp()	Задает интервал перед указанными абзацами в 12 точек.
outdent()	Удаляет один уровень отступа для абзацев.
outlineDemote()	Применяет следующий стиль уровня заголовка (заголовок с 1 по заголовок 8) к указанным абзацам.
outlineDemoteToBody()	Понижает указанные абзацы до основного текста, применяя стиль "Обычный".
outlinePromote()	Применяет предыдущий стиль уровня заголовка (заголовок с 1 по заголовок 8) к абзацам в коллекции.
space1()	Задает для указанных абзацев один интервал.
space1Pt5()	Задает для указанных абзацев интервал между 1,5 строками.
space2()	Задает для указанных абзацев двойной интервал.
tabHangingIndent(count)	Задает висячий отступ для указанного числа остановок табуляции.
tabIndent(count)	Задает в левом отступе для указанных абзацев указанное количество табуляции.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.ParagraphCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ParagraphCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

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

context

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

context: RequestContext;

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

Word.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Word.Paragraph[];

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

Word.Paragraph[]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml

// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list: Word.List = paragraphs.items[1].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph: Word.Paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set up list level for the list item.
  paragraph.listItem.level = 4;

  // To add paragraphs outside the list, use Before or After.
  list.insertParagraph("New paragraph goes after (not part of the list)", "After");

  await context.sync();
});

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

add(range)

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

add(range: Word.Range): Word.Paragraph;

Параметры

range

Word.Range

Диапазон, до которого требуется добавить новый абзац. Новый абзац не заменяет диапазон.

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

Word.Paragraph

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

closeUp()

Удаляет все интервалы перед указанными абзацами.

closeUp(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

decreaseSpacing()

Уменьшает интервалы до и после абзацев с шагом в шесть пунктов.

decreaseSpacing(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

getFirst()

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

getFirst(): Word.Paragraph;

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Gets annotations found in the selected paragraph.
await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  const annotations: Word.AnnotationCollection = paragraph.getAnnotations();
  annotations.load("id,state,critiqueAnnotation");

  await context.sync();

  console.log("Annotations found:");

  for (let i = 0; i < annotations.items.length; i++) {
    const annotation: Word.Annotation = annotations.items[i];

    console.log(`ID ${annotation.id} - state '${annotation.state}':`, annotation.critiqueAnnotation.critique);
  }
});

getFirstOrNullObject()

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

getFirstOrNullObject(): Word.Paragraph;

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

getLast()

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

getLast(): Word.Paragraph;

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml

// Inserts an image anchored to the last paragraph.
await Word.run(async (context) => {
  context.document.body.paragraphs
    .getLast()
    .insertParagraph("", "After")
    .insertInlinePictureFromBase64(base64Image, "End");

  await context.sync();
});

getLastOrNullObject()

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

getLastOrNullObject(): Word.Paragraph;

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

increaseSpacing()

Увеличивает интервалы до и после абзацев с шагом в шесть пунктов.

increaseSpacing(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

indent()

Отступы абзацев на один уровень.

indent(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

indentCharacterWidth(count)

Отступы абзацев в коллекции на указанное количество символов.

indentCharacterWidth(count: number): void;

Параметры

count

number

Количество символов, на которые должны быть отступированы для указанных абзацев.

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

indentFirstLineCharacterWidth(count)

Отступ первой строки абзацев в коллекции на указанное количество символов.

indentFirstLineCharacterWidth(count: number): void;

Параметры

count

number

Количество символов, на которое должна быть отступ в первой строке каждого указанного абзаца.

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

load(options)

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

load(options?: Word.Interfaces.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ParagraphCollection;

Параметры

options

Word.Interfaces.ParagraphCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

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

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

Word.ParagraphCollection

Примеры

// This example shows how to get the paragraphs in the Word document
// along with their text and font size properties.
// 
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a proxy object for the paragraphs collection.
    const paragraphs = context.document.body.paragraphs;

    // Queue a command to load the text and font properties.
    // It is best practice to always specify the property set. Otherwise, all properties are
    // returned in on the object.
    paragraphs.load('text, font/size');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();

    // Insert code that works with the paragraphs loaded by paragraphs.load().
});

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.ParagraphCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ParagraphCollection;

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Word.ParagraphCollection

openOrCloseUp()

Переключает интервалы перед абзацами.

openOrCloseUp(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

openUp()

Задает интервал перед указанными абзацами в 12 точек.

openUp(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

outdent()

Удаляет один уровень отступа для абзацев.

outdent(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

outlineDemote()

Применяет следующий стиль уровня заголовка (заголовок с 1 по заголовок 8) к указанным абзацам.

outlineDemote(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

outlineDemoteToBody()

Понижает указанные абзацы до основного текста, применяя стиль "Обычный".

outlineDemoteToBody(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

outlinePromote()

Применяет предыдущий стиль уровня заголовка (заголовок с 1 по заголовок 8) к абзацам в коллекции.

outlinePromote(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

space1()

Задает для указанных абзацев один интервал.

space1(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

space1Pt5()

Задает для указанных абзацев интервал между 1,5 строками.

space1Pt5(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

space2()

Задает для указанных абзацев двойной интервал.

space2(): void;

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

tabHangingIndent(count)

Задает висячий отступ для указанного числа остановок табуляции.

tabHangingIndent(count: number): void;

Параметры

count

number

Количество отступов табуляции (при положительном значении) или количество тонок табуляции, которые нужно удалить из отступа (если отрицательный).

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

tabIndent(count)

Задает в левом отступе для указанных абзацев указанное количество табуляции.

tabIndent(count: number): void;

Параметры

count

number

Количество отступов табуляции (при положительном значении) или количество тонок табуляции, которые нужно удалить из отступа (если отрицательный).

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

void

Комментарии

[ Набор API: WordApiDesktop 1.4 ]

toJSON()

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

toJSON(): Word.Interfaces.ParagraphCollectionData;

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

Word.Interfaces.ParagraphCollectionData

track()

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

track(): Word.ParagraphCollection;

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

Word.ParagraphCollection

untrack()

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

untrack(): Word.ParagraphCollection;

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

Word.ParagraphCollection