Word.ParagraphCollection class

Пакет:

word

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

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: WordApi 1.1

Используется

• Word. Текст: абзацы
• Word. ContentControl: абзацы
• Word. Документ: listParagraphs, paragraphs
• Word. Список: getLevelParagraphs, paragraphs
• Word. ListItem: getDescendants
• Word. Диапазон: абзацы
• Word. Выделение: абзацы

Примеры

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