Word.Paragraph class

Ссылка

Пакет:: word

Представляет один абзац в выделении, диапазоне, элементе управления содержимым или тексте документа.

Extends: OfficeExtension.ClientObject

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml

await Word.run(async (context) => {
  // The collection of paragraphs of the current selection returns the full paragraphs contained in it.
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  paragraph.load("text");

  await context.sync();
  console.log(paragraph.text);
});

Свойства

alignment	Задает выравнивание абзаца. Возможные значения: left, centered, right и justified.
contentControls	Возвращает коллекцию объектов элементов управления содержимым в абзаце.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
endnotes	Возвращает коллекцию концевых сносок в абзаце.
fields	Возвращает коллекцию полей в абзаце.
firstLineIndent	Задает значение (в пунктах) для первой строки или отступа. Для установки отступа первой строки укажите положительное значение и используйте отрицательное значение, чтобы задать выступ.
font	Возвращает формат текста абзаца. Используйте это свойство для получения и задания имени, размера, цвета и других свойств шрифта.
footnotes	Возвращает коллекцию сносок в абзаце.
inlinePictures	Возвращает коллекцию объектов InlinePicture в абзаце. Коллекция не включает плавающие изображения.
isLastParagraph	Указывает, что абзац является последним в родительском тексте.
isListItem	Проверяет, является ли абзац элементом списка.
leftIndent	Задает значение левого отступа (в пунктах) для абзаца.
lineSpacing	Задает междустрочный интервал (в точках) для указанного абзаца. В пользовательском интерфейсе Word это значение делится на 12.
lineUnitAfter	Указывает интервал в строках сетки после абзаца.
lineUnitBefore	Указывает интервал в строках сетки перед абзацем.
list	Возвращает объект List, к которому относится абзац. Выдает ошибку `ItemNotFound` , если абзац отсутствует в списке.
listItem	Возвращает объект ListItem для абзаца. Выдает ошибку `ItemNotFound` , если абзац не является частью списка.
listItemOrNullObject	Возвращает объект ListItem для абзаца. Если абзац не является частью списка, этот метод вернет объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
listOrNullObject	Возвращает объект List, к которому относится абзац. Если абзац отсутствует в списке, этот метод вернет объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
outlineLevel	Задает уровень структуры для абзаца.
parentBody	Возвращает родительский текст абзаца.
parentContentControl	Возвращает элемент управления содержимым, содержащий абзац. Выдает ошибку `ItemNotFound` , если родительского элемента управления содержимым нет.
parentContentControlOrNullObject	Возвращает элемент управления содержимым, содержащий абзац. Если родительского элемента управления содержимым нет, этот метод вернет объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTable	Возвращает таблицу, содержащую абзац. Выдает ошибку `ItemNotFound` , если она не содержится в таблице.
parentTableCell	Возвращает ячейку таблицы, содержащую абзац. Выдает ошибку `ItemNotFound` , если она не содержится в ячейке таблицы.
parentTableCellOrNullObject	Возвращает ячейку таблицы, содержащую абзац. Если он не содержится в ячейке таблицы, этот метод вернет объект со свойством , для него `isNullObject` задано значение `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTableOrNullObject	Возвращает таблицу, содержащую абзац. Если он не содержится в таблице, то этот метод вернет объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
rightIndent	Задает значение отступа вправо (в пунктах) для абзаца.
spaceAfter	Задает интервал (в точках) после абзаца.
spaceBefore	Задает интервал (в пунктах) перед абзацем.
style	Задает имя стиля абзаца. Используйте это свойство для пользовательских стилей и локализованных имен стилей. Чтобы использовать встроенные стили, поддерживающие несколько языковых стандартов, применяйте свойство styleBuiltIn.
styleBuiltIn	Указывает встроенное имя стиля для абзаца. Используйте это свойство для встроенных стилей, поддерживающих несколько языковых стандартов. Чтобы использовать пользовательские стили или локализованные имена стилей, применяйте свойство style.
tableNestingLevel	Возвращает уровень таблицы, содержащей абзац. Если абзац отсутствует в таблице, возвращается значение 0.
text	Возвращает текст абзаца.
uniqueLocalId	Возвращает строку, представляющую идентификатор абзаца в текущем сеансе. Идентификатор имеет стандартный формат GUID 8-4-4-4-12 без фигурных скобок и отличается между сеансами и соавторами.

Методы

attachToList(listId, level)	Позволяет присоединить абзац к существующему списку на указанном уровне. Если присоединить абзац к списку не удается или он уже является элементом списка, метод не выполняется.
clear()	Очищает содержимое объекта абзаца. Пользователь может отменить операцию для очищенного содержимого.
delete()	Удаляет абзац и его содержимое из документа.
detachFromList()	Перемещает абзац за пределы списка (если он является элементом списка).
getAnnotations()	Возвращает заметки, заданные для этого объекта Paragraph.
getComments()	Возвращает примечания, связанные с абзацем.
getContentControls(options)	Возвращает поддерживаемые в настоящее время элементы управления содержимым в абзаце.
getHtml()	Возвращает HTML-представление объекта абзаца. При отображении на веб-странице или в средстве просмотра HTML форматирование будет близко, но не точно совпадает с форматированием документа. Этот метод не возвращает один и тот же HTML-код для одного документа на разных платформах (Windows, Mac, Word в Интернете и т. д.). Если вам нужна точную точность или согласованность на разных платформах, используйте `Paragraph.getOoxml()` и преобразуйте возвращенный XML-код в HTML.
getNext()	Возвращает следующий абзац. Выдает ошибку, `ItemNotFound` если абзац является последним.
getNextOrNullObject()	Возвращает следующий абзац. Если абзац является последним, этот метод вернет объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getOoxml()	Возвращает OOXML-представление объекта абзаца.
getPrevious()	Возвращает предыдущий абзац. Выдает ошибку `ItemNotFound` , если абзац является первым.
getPreviousOrNullObject()	Возвращает предыдущий абзац. Если абзац является первым, то этот метод возвращает объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRange(rangeLocation)	Возвращает весь абзац (либо его начальную или конечную точку) в виде диапазона.
getReviewedText(changeTrackingVersion)	Возвращает проверенный текст на основе выбора ChangeTrackingVersion.
getReviewedText(changeTrackingVersionString)	Возвращает проверенный текст на основе выбора ChangeTrackingVersion.
getText(options)	Возвращает текст абзаца. Это исключает уравнения, графику (например, изображения, видео, рисунки) и специальные символы, которые помечают различное содержимое (например, для элементов управления содержимым, полей, комментариев, сносок, концевых сносок). По умолчанию скрытый текст и текст, помеченный как удаленный, исключаются.
getTextRanges(endingMarks, trimSpacing)	Возвращает текстовые диапазоны в абзаце с помощью знаков препинания и (или) других конечных знаков.
getTrackedChanges()	Возвращает коллекцию объектов TrackedChange в абзаце.
insertAnnotations(annotations)	Вставляет заметки к этому объекту Paragraph.
insertBreak(breakType, insertLocation)	Вставляет разрыв в указанном расположении в основном документе.
insertContentControl(contentControlType)	Заключает объект Paragraph в элемент управления содержимым.
insertFileFromBase64(base64File, insertLocation)	Вставляет документ в абзац в указанном расположении.
insertHtml(html, insertLocation)	Вставляет HTML в абзац в указанном расположении.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Вставляет рисунок в абзац в указанном расположении.
insertOoxml(ooxml, insertLocation)	Вставляет OOXML в абзац в указанном расположении.
insertParagraph(paragraphText, insertLocation)	Вставляет абзац в указанном расположении.
insertTable(rowCount, columnCount, insertLocation, values)	Вставляет таблицу с указанным количеством строк и столбцов.
insertText(text, insertLocation)	Вставляет текст в абзац в указанном расположении.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
search(searchText, searchOptions)	Выполняет поиск с указанным SearchOptions на область объекта абзаца. Результат поиска — это коллекция объектов диапазона.
select(selectionMode)	Выбирает абзац и переходит к нему в пользовательском интерфейсе Word.
select(selectionModeString)	Выбирает абзац и переходит к нему в пользовательском интерфейсе Word.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
split(delimiters, trimDelimiters, trimSpacing)	Разделяет абзац на дочерние диапазоны с помощью разделителей.
startNewList()	Создает список, начинающийся с данного абзаца. Если абзац уже является элементом списка, метод не выполняется.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.Paragraph` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Word.Interfaces.ParagraphData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

События

onCommentAdded	Происходит при добавлении новых комментариев.
onCommentChanged	Происходит при изменении комментария или его ответа.
onCommentDeleted	Происходит при удалении комментариев.
onCommentDeselected	Происходит при отмене выбора комментария.
onCommentSelected	Происходит при выборе комментария.

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

alignment

Задает выравнивание абзаца. Возможные значения: left, centered, right и justified.

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Center last paragraph alignment.
  context.document.body.paragraphs.getLast().alignment = "Centered";

  await context.sync();
});

contentControls

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

readonly contentControls: Word.ContentControlCollection;

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

Word.ContentControlCollection

context

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

context: RequestContext;

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

Word.RequestContext

endnotes

Возвращает коллекцию концевых сносок в абзаце.

readonly endnotes: Word.NoteItemCollection;

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

Word.NoteItemCollection

fields

Возвращает коллекцию полей в абзаце.

readonly fields: Word.FieldCollection;

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

Word.FieldCollection

firstLineIndent

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

firstLineIndent: number;

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

number

font

Возвращает формат текста абзаца. Используйте это свойство для получения и задания имени, размера, цвета и других свойств шрифта.

readonly font: Word.Font;

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

Word.Font

footnotes

Возвращает коллекцию сносок в абзаце.

readonly footnotes: Word.NoteItemCollection;

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

Word.NoteItemCollection

inlinePictures

Возвращает коллекцию объектов InlinePicture в абзаце. Коллекция не включает плавающие изображения.

readonly inlinePictures: Word.InlinePictureCollection;

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

Word.InlinePictureCollection

isLastParagraph

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

readonly isLastParagraph: boolean;

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

boolean

isListItem

Проверяет, является ли абзац элементом списка.

readonly isListItem: boolean;

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

boolean

leftIndent

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

leftIndent: number;

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

number

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Indent the first paragraph.
  context.document.body.paragraphs.getFirst().leftIndent = 75; //units = points

  return context.sync();
});

lineSpacing

Задает междустрочный интервал (в точках) для указанного абзаца. В пользовательском интерфейсе Word это значение делится на 12.

lineSpacing: number;

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

number

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Adjust line spacing.
  context.document.body.paragraphs.getFirst().lineSpacing = 20;

  await context.sync();
});

lineUnitAfter

Указывает интервал в строках сетки после абзаца.

lineUnitAfter: number;

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

number

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Set the space (in line units) after the first paragraph.
  context.document.body.paragraphs.getFirst().lineUnitAfter = 1;

  await context.sync();
});

lineUnitBefore

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

lineUnitBefore: number;

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

number

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Set the space (in line units) before the first paragraph.
  context.document.body.paragraphs.getFirst().lineUnitBefore = 1;

  await context.sync();
});

list

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

readonly list: Word.List;

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

Word.List

listItem

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

readonly listItem: Word.ListItem;

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

Word.ListItem

listItemOrNullObject

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

readonly listItemOrNullObject: Word.ListItem;

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

Word.ListItem

listOrNullObject

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

readonly listOrNullObject: Word.List;

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

Word.List

outlineLevel

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

outlineLevel: number;

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

number

parentBody

Возвращает родительский текст абзаца.

readonly parentBody: Word.Body;

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

Word.Body

parentContentControl

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

readonly parentContentControl: Word.ContentControl;

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

Word.ContentControl

parentContentControlOrNullObject

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

readonly parentContentControlOrNullObject: Word.ContentControl;

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

Word.ContentControl

parentTable

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

readonly parentTable: Word.Table;

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

Word.Table

parentTableCell

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

readonly parentTableCell: Word.TableCell;

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

Word.TableCell

parentTableCellOrNullObject

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

readonly parentTableCellOrNullObject: Word.TableCell;

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

Word.TableCell

parentTableOrNullObject

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

readonly parentTableOrNullObject: Word.Table;

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

Word.Table

rightIndent

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

rightIndent: number;

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

number

spaceAfter

Задает интервал (в точках) после абзаца.

spaceAfter: number;

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

number

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml

await Word.run(async (context) => {
  // Set the space (in points) after the first paragraph.
  context.document.body.paragraphs.getFirst().spaceAfter = 20;

  await context.sync();
});

spaceBefore

Задает интервал (в пунктах) перед абзацем.

spaceBefore: number;

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

number

style

Задает имя стиля абзаца. Используйте это свойство для пользовательских стилей и локализованных имен стилей. Чтобы использовать встроенные стили, поддерживающие несколько языковых стандартов, применяйте свойство styleBuiltIn.

style: string;

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

string

Примеры

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

// Applies the specified style to a paragraph.
await Word.run(async (context) => {
  const styleName = $("#style-name-to-use").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to apply.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else if (style.type != Word.StyleType.paragraph) {
    console.log(`The '${styleName}' style isn't a paragraph style.`);
  } else {
    const body: Word.Body = context.document.body;
    body.clear();
    body.insertParagraph(
      "Do you want to create a solution that extends the functionality of Word? You can use the Office Add-ins platform to extend Word clients running on the web, on a Windows desktop, or on a Mac.",
      "Start"
    );
    const paragraph: Word.Paragraph = body.paragraphs.getFirst();
    paragraph.style = style.nameLocal;
    console.log(`'${styleName}' style applied to first paragraph.`);
  }
});

styleBuiltIn

Указывает встроенное имя стиля для абзаца. Используйте это свойство для встроенных стилей, поддерживающих несколько языковых стандартов. Чтобы использовать пользовательские стили или локализованные имена стилей, применяйте свойство style.

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/doc-assembly.yaml

await Word.run(async (context) => {
    const paragraph: Word.Paragraph = context.document.body.insertParagraph("Timeline", "End");
    paragraph.styleBuiltIn = "Heading2";
    const paragraph2: Word.Paragraph = context.document.body.insertParagraph("The Services shall commence on July 31, 2015, and shall continue through July 29, 2015.", "End");
    paragraph2.styleBuiltIn = "Normal";
    const paragraph3: Word.Paragraph = context.document.body.insertParagraph("Project Costs by Phase", "End");
    paragraph3.styleBuiltIn = "Heading2";
    // Note a content control with the title of "ProjectCosts" is added. Content will be replaced later.
    const paragraph4: Word.Paragraph = context.document.body.insertParagraph("<Add Project Costs Here>", "End");
    paragraph4.styleBuiltIn = "Normal";
    paragraph4.font.highlightColor = "#FFFF00";
    const contentControl: Word.ContentControl = paragraph4.insertContentControl();
    contentControl.title = "ProjectCosts";
    const paragraph5: Word.Paragraph = context.document.body.insertParagraph("Project Team", "End");
    paragraph5.styleBuiltIn = "Heading2";
    paragraph5.font.highlightColor = "#FFFFFF";
    const paragraph6: Word.Paragraph = context.document.body.insertParagraph("Terms of Work", "End");
    paragraph6.styleBuiltIn = "Heading1";
    const paragraph7: Word.Paragraph = context.document.body.insertParagraph("Contractor shall provide the Services and Deliverable(s) as follows:", "End");
    paragraph7.styleBuiltIn = "Normal";
    const paragraph8: Word.Paragraph = context.document.body.insertParagraph("Out-of-Pocket Expenses / Invoice Procedures", "End");
    paragraph8.styleBuiltIn = "Heading2";
    const paragraph9 : Word.Paragraph= context.document.body.insertParagraph("Client will be invoiced monthly for the consulting services and T&L expenses. Standard Contractor invoicing is assumed to be acceptable. Invoices are due upon receipt. client will be invoiced all costs associated with out-of-pocket expenses (including, without limitation, costs and expenses associated with meals, lodging, local transportation and any other applicable business expenses) listed on the invoice as a separate line item. Reimbursement for out-of-pocket expenses in connection with performance of this SOW, when authorized and up to the limits set forth in this SOW, shall be in accordance with Client's then-current published policies governing travel and associated business expenses, which information shall be provided by the Client Project Manager.", "End");
    paragraph9.styleBuiltIn = "Normal";
    // Insert a page break at the end of the document.
    context.document.body.insertBreak("Page", "End");

    await context.sync();
});

tableNestingLevel

Возвращает уровень таблицы, содержащей абзац. Если абзац отсутствует в таблице, возвращается значение 0.

readonly tableNestingLevel: number;

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

number

text

Возвращает текст абзаца.

readonly text: string;

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

string

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml

await Word.run(async (context) => {
  // The collection of paragraphs of the current selection returns the full paragraphs contained in it.
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  paragraph.load("text");

  await context.sync();
  console.log(paragraph.text);
});

uniqueLocalId

Возвращает строку, представляющую идентификатор абзаца в текущем сеансе. Идентификатор имеет стандартный формат GUID 8-4-4-4-12 без фигурных скобок и отличается между сеансами и соавторами.

readonly uniqueLocalId: string;

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

string

Примеры

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

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function paragraphChanged(args: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    const results = [];
    for (let id of args.uniqueLocalIds) {
      let para = context.document.getParagraphByUniqueLocalId(id);
      para.load("uniqueLocalId");

      results.push({ para: para, text: para.getText() });
    }

    await context.sync();

    for (let result of results) {
      console.log(`${args.type}: ID ${result.para.uniqueLocalId}:-`, result.text.value);
    }
  });
}

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

attachToList(listId, level)

Позволяет присоединить абзац к существующему списку на указанном уровне. Если присоединить абзац к списку не удается или он уже является элементом списка, метод не выполняется.

attachToList(listId: number, level: number): Word.List;

Параметры

listId: number

Обязательно. Идентификатор существующего списка.

level: number

Обязательно. Уровень в списке.

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

Word.List

clear()

Очищает содержимое объекта абзаца. Пользователь может отменить операцию для очищенного содержимого.

clear(): void;

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

void

Примеры

// 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 style property for all of the paragraphs.
    paragraphs.load('style');

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

    // Queue a command to clear the contents of the first paragraph.
    paragraphs.items[0].clear();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Cleared the contents of the first paragraph.');
});

delete()

Удаляет абзац и его содержимое из документа.

delete(): void;

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

void

Примеры

// 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 property for all of the paragraphs.
    paragraphs.load('text');

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

    // Queue a command to delete the first paragraph.
    paragraphs.items[0].delete();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Deleted the first paragraph.');
});

detachFromList()

Перемещает абзац за пределы списка (если он является элементом списка).

detachFromList(): void;

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

void

getAnnotations()

Возвращает заметки, заданные для этого объекта Paragraph.

getAnnotations(): Word.AnnotationCollection;

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

Word.AnnotationCollection

getComments()

Возвращает примечания, связанные с абзацем.

getComments(): Word.CommentCollection;

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

Word.CommentCollection

getContentControls(options)

Возвращает поддерживаемые в настоящее время элементы управления содержимым в абзаце.

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

Параметры

options: Word.ContentControlOptions

Необязательный параметр. Параметры, определяющие возвращаемые элементы управления содержимым.

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

Word.ContentControlCollection

Важно! Если в параметре options указаны определенные типы, возвращаются только элементы управления содержимым поддерживаемых типов. Имейте в виду, что при использовании методов универсального Word будет создано исключение. ContentControl, который не относится к конкретному типу. Со временем могут поддерживаться дополнительные типы элементов управления содержимым. Поэтому надстройка должна запрашивать и обрабатывать определенные типы элементов управления содержимым.

getHtml()

Возвращает HTML-представление объекта абзаца. При отображении на веб-странице или в средстве просмотра HTML форматирование будет близко, но не точно совпадает с форматированием документа. Этот метод не возвращает один и тот же HTML-код для одного документа на разных платформах (Windows, Mac, Word в Интернете и т. д.). Если вам нужна точную точность или согласованность на разных платформах, используйте Paragraph.getOoxml() и преобразуйте возвращенный XML-код в HTML.

getHtml(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Примеры

// 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 style property for all of the paragraphs.
    paragraphs.load('style');

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

    // Queue a set of commands to get the HTML of the first paragraph.
    const html = paragraphs.items[0].getHtml();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Paragraph HTML: ' + html.value);
});

getNext()

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

getNext(): Word.Paragraph;

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

Word.Paragraph

getNextOrNullObject()

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

getNextOrNullObject(): Word.Paragraph;

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

Word.Paragraph

getOoxml()

Возвращает OOXML-представление объекта абзаца.

getOoxml(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Примеры

// 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 style property for the top 2 paragraphs.
    paragraphs.load({select: 'style', top: 2} );

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

    // Queue a set of commands to get the OOXML of the first paragraph.
    const ooxml = paragraphs.items[0].getOoxml();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Paragraph OOXML: ' + ooxml.value);
});

getPrevious()

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

getPrevious(): Word.Paragraph;

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

Word.Paragraph

getPreviousOrNullObject()

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

getPreviousOrNullObject(): Word.Paragraph;

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

Word.Paragraph

Примеры

// 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 property for all of the paragraphs.
    paragraphs.load('text');

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

    // Queue commands to create a proxy object for the next-to-last paragraph.
    const indexOfLastParagraph = paragraphs.items.length - 1;
    const precedingParagraph = paragraphs.items[indexOfLastParagraph].getPreviousOrNullObject();

    // Queue a command to load the text of the preceding paragraph.
    precedingParagraph.load('text');

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    if (precedingParagraph.isNullObject) {
        console.log('There are no paragraphs before the current one.');
    } else {
        console.log('The preceding paragraph is: ' + precedingParagraph.text);
    }
});

getRange(rangeLocation)

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

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

Параметры

rangeLocation: whole | start | end | after | content | "Whole" | "Start" | "End" | "After" | "Content"

Необязательный параметр. Диапазон должен находиться в диапазоне "Whole", "Start", "End", "After" или "Content".

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

Word.Range

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml

await Word.run(async (context) => {
  // Get the complete sentence (as range) associated with the insertion point.
  const sentences: Word.RangeCollection = context.document
    .getSelection()
    .getTextRanges(["."] /* Using the "." as delimiter */, false /*means without trimming spaces*/);
  sentences.load("$none");
  await context.sync();

  // Expand the range to the end of the paragraph to get all the complete sentences.
  const sentencesToTheEndOfParagraph: Word.RangeCollection = sentences.items[0]
    .getRange()
    .expandTo(
      context.document
        .getSelection()
        .paragraphs.getFirst()
        .getRange(Word.RangeLocation.end)
    )
    .getTextRanges(["."], false /* Don't trim spaces*/);
  sentencesToTheEndOfParagraph.load("text");
  await context.sync();

  for (let i = 0; i < sentencesToTheEndOfParagraph.items.length; i++) {
    console.log(sentencesToTheEndOfParagraph.items[i].text);
  }
});

getReviewedText(changeTrackingVersion)

Возвращает проверенный текст на основе выбора ChangeTrackingVersion.

getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;

Параметры

changeTrackingVersion: Word.ChangeTrackingVersion

Необязательный параметр. Значение должно быть "Original" или "Current". Значение по умолчанию — Current.

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

OfficeExtension.ClientResult<string>

getReviewedText(changeTrackingVersionString)

Возвращает проверенный текст на основе выбора ChangeTrackingVersion.

getReviewedText(changeTrackingVersionString?: "Original" | "Current"): OfficeExtension.ClientResult<string>;

Параметры

changeTrackingVersionString: "Original" | "Current"

Необязательный параметр. Значение должно быть "Original" или "Current". Значение по умолчанию — Current.

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

OfficeExtension.ClientResult<string>

getText(options)

Возвращает текст абзаца. Это исключает уравнения, графику (например, изображения, видео, рисунки) и специальные символы, которые помечают различное содержимое (например, для элементов управления содержимым, полей, комментариев, сносок, концевых сносок). По умолчанию скрытый текст и текст, помеченный как удаленный, исключаются.

getText(options?: Word.GetTextOptions | {
            IncludeHiddenText?: boolean;
            IncludeTextMarkedAsDeleted?: boolean;
        }): OfficeExtension.ClientResult<string>;

Параметры

options: Word.GetTextOptions | { IncludeHiddenText?: boolean; IncludeTextMarkedAsDeleted?: boolean; }

Необязательный параметр. Параметры, определяющие, должен ли конечный результат включать скрытый текст и текст, помеченный как удаленный.

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

OfficeExtension.ClientResult<string>

getTextRanges(endingMarks, trimSpacing)

Возвращает текстовые диапазоны в абзаце с помощью знаков препинания и (или) других конечных знаков.

getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;

Параметры

endingMarks: string[]

Обязательно. Знаки препинания и (или) другие конечные знаки в виде массива строк.

trimSpacing: boolean

Необязательный параметр. Указывает, следует ли обрезать символы интервалов (пробелы, табуляции, разрывы столбцов и конце абзаца) от начала и конца диапазонов, возвращаемых в коллекции диапазонов. Значение по умолчанию равно false, указывающее, что символы с интервалами в начале и конце диапазонов включены в коллекцию диапазонов.

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

Word.RangeCollection

getTrackedChanges()

Возвращает коллекцию объектов TrackedChange в абзаце.

getTrackedChanges(): Word.TrackedChangeCollection;

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

Word.TrackedChangeCollection

insertAnnotations(annotations)

Вставляет заметки к этому объекту Paragraph.

insertAnnotations(annotations: Word.AnnotationSet): OfficeExtension.ClientResult<string[]>;

Параметры

annotations: Word.AnnotationSet

Заметки для задания.

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

OfficeExtension.ClientResult<string[]>

Массив идентификаторов вставленных заметок.

Примеры

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

// Adds annotations to the selected paragraph.
await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
  const options: Word.CritiquePopupOptions = {
    brandingTextResourceId: "PG.TabLabel",
    subtitleResourceId: "PG.HelpCommand.TipTitle",
    titleResourceId: "PG.HelpCommand.Label",
    suggestions: ["suggestion 1", "suggestion 2", "suggestion 3"]
  };
  const critique1: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.red,
    start: 1,
    length: 3,
    popupOptions: options
  };
  const critique2: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.green,
    start: 6,
    length: 1,
    popupOptions: options
  };
  const critique3: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.blue,
    start: 10,
    length: 3,
    popupOptions: options
  };
  const critique4: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.lavender,
    start: 14,
    length: 3,
    popupOptions: options
  };
  const critique5: Word.Critique = {
    colorScheme: Word.CritiqueColorScheme.berry,
    start: 18,
    length: 10,
    popupOptions: options
  };
  const annotationSet: Word.AnnotationSet = {
    critiques: [critique1, critique2, critique3, critique4, critique5]
  };

  const annotationIds = paragraph.insertAnnotations(annotationSet);

  await context.sync();

  console.log("Annotations inserted:", annotationIds.value);
});

insertBreak(breakType, insertLocation)

Вставляет разрыв в указанном расположении в основном документе.

insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;

Параметры

breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

Обязательно. Тип разрыва, который необходимо добавить в документ.

insertLocation: before | after | "Before" | "After"

Обязательно. Значение должно быть "До" или "После".

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

void

Примеры

// 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 style property for the top 2 paragraphs.
    // We never perform an empty load. We always must request a property.
    paragraphs.load({select: 'style', top: 2} );

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

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    // Queue a command to insert a page break after the first paragraph.
    paragraph.insertBreak(Word.BreakType.page, Word.InsertLocation.after);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted a page break after the paragraph.');
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-line-and-page-breaks.yaml

Word.run(async (context) => {
  context.document.body.paragraphs.getFirst().insertBreak(Word.BreakType.line, "After");

  await context.sync();
  console.log("success");
});

insertContentControl(contentControlType)

Заключает объект Paragraph в элемент управления содержимым.

insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl;

Параметры

contentControlType: richText | plainText | checkBox | dropDownList | comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"

Необязательный параметр. Тип элемента управления содержимым для вставки. Должны быть "RichText", "PlainText", "CheckBox", "DropDownList" или "ComboBox". Значение по умолчанию — RichText.

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

Word.ContentControl

Примечание. Параметр contentControlType появился в WordApi 1.5. PlainText добавлена поддержка в WordApi 1.5. CheckBox добавлена поддержка в WordApi 1.7. DropDownList добавлена поддержка и ComboBox в WordApi 1.9.

Примеры

// 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 style property for the top 2 paragraphs.
    // We never perform an empty load. We always must request a property.
    paragraphs.load({select: 'style', top: 2} );

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

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    // Queue a command to wrap the first paragraph in a rich text content control.
    paragraph.insertContentControl();

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Wrapped the first paragraph in a content control.');
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-content-controls.yaml

// Traverses each paragraph of the document and wraps a content control on each with either a even or odd tags.
await Word.run(async (context) => {
  let paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none"); // Don't need any properties; just wrap each paragraph with a content control.

  await context.sync();

  for (let i = 0; i < paragraphs.items.length; i++) {
    let contentControl = paragraphs.items[i].insertContentControl();
    // For even, tag "even".
    if (i % 2 === 0) {
      contentControl.tag = "even";
    } else {
      contentControl.tag = "odd";
    }
  }
  console.log("Content controls inserted: " + paragraphs.items.length);

  await context.sync();
});

insertFileFromBase64(base64File, insertLocation)

Вставляет документ в абзац в указанном расположении.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Параметры

base64File: string

Обязательно. Содержимое файла .docx в кодировке Base64.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Обязательно. Значение должно быть "Replace", "Start" или "End".

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

Word.Range

Примечание. Вставка не поддерживается, если вставляемый документ содержит элемент ActiveX (вероятно, в поле формы). Рассмотрите возможность замены такого поля формы элементом управления содержимым или другим вариантом, подходящим для вашего сценария.

insertHtml(html, insertLocation)

Вставляет HTML в абзац в указанном расположении.

insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Параметры

html: string

Обязательно. HTML-код, который необходимо вставить в абзац.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Обязательно. Значение должно быть "Replace", "Start" или "End".

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

Word.Range

Примеры

// 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 style property for the top 2 paragraphs.
    // We never perform an empty load. We always must request a property.
    paragraphs.load({select: 'style', top: 2} );

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

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    // Queue a command to insert HTML content at the end of the first paragraph.
    paragraph.insertHtml('<strong>Inserted HTML.</strong>', Word.InsertLocation.end);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted HTML content at the end of the first paragraph.');
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Вставляет рисунок в абзац в указанном расположении.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;

Параметры

base64EncodedImage: string

Обязательно. Вставляемый образ в кодировке Base64.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Обязательно. Значение должно быть "Replace", "Start" или "End".

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

Word.InlinePicture

Примеры

// 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 style property for all of the paragraphs.
    paragraphs.load('style');

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

    // Queue a command to get the first paragraph.
    const paragraph = paragraphs.items[0];

    const b64encodedImg = "iVBORw0KGgoAAAANSUhEUgAAAB4AAAANCAIAAAAxEEnAAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACFSURBVDhPtY1BEoQwDMP6/0+XgIMTBAeYoTqso9Rkx1zG+tNj1H94jgGzeNSjteO5vtQQuG2seO0av8LzGbe3anzRoJ4ybm/VeKEerAEbAUpW4aWQCmrGFWykRzGBCnYy2ha3oAIq2MloW9yCCqhgJ6NtcQsqoIKdjLbFLaiACnYyf2fODbrjZcXfr2F4AAAAAElFTkSuQmCC";

    // Queue a command to insert a base64 encoded image at the beginning of the first paragraph.
    paragraph.insertInlinePictureFromBase64(b64encodedImg, Word.InsertLocation.start);

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Added an image to the first paragraph.');
});

insertOoxml(ooxml, insertLocation)

Вставляет OOXML в абзац в указанном расположении.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Параметры

ooxml: string

Обязательно. OOXML, который будет вставлен в абзац.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Обязательно. Значение должно быть "Replace", "Start" или "End".

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

Word.Range

insertParagraph(paragraphText, insertLocation)

Вставляет абзац в указанном расположении.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

Параметры

paragraphText: string

Обязательно. Текст абзаца, который необходимо вставить.

insertLocation: before | after | "Before" | "After"

Обязательно. Значение должно быть "До" или "После".

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

Word.Paragraph

insertTable(rowCount, columnCount, insertLocation, values)

Вставляет таблицу с указанным количеством строк и столбцов.

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;

Параметры

rowCount: number

Обязательно. Количество строк в таблице.

columnCount: number

Обязательно. Количество столбцов в таблице.

insertLocation: before | after | "Before" | "After"

Обязательно. Значение должно быть "До" или "После".

values: string[][]

Необязательный двухмерный массив. Ячейки заполняются, если в массиве указаны соответствующие строки.

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

Word.Table

insertText(text, insertLocation)

Вставляет текст в абзац в указанном расположении.

insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;

Параметры

text: string

Обязательно. Текст, который необходимо вставить.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

Обязательно. Значение должно быть "Replace", "Start" или "End".

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

Word.Range

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-in-different-locations.yaml

await Word.run(async (context) => {
  // Replace the last paragraph.
  const range: Word.Range = context.document.body.paragraphs.getLast().insertText("Just replaced the last paragraph!", "Replace");
  range.font.highlightColor = "black";
  range.font.color = "white";

  await context.sync();
});

load(options)

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

load(options?: Word.Interfaces.ParagraphLoadOptions): Word.Paragraph;

Параметры

options: Word.Interfaces.ParagraphLoadOptions

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

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

Word.Paragraph

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Word.Paragraph

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Word.Paragraph

search(searchText, searchOptions)

Выполняет поиск с указанным SearchOptions на область объекта абзаца. Результат поиска — это коллекция объектов диапазона.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Параметры

searchText: string

Обязательно. Текст для поиска.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Необязательный параметр. Параметры поиска.

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

Word.RangeCollection

select(selectionMode)

Выбирает абзац и переходит к нему в пользовательском интерфейсе Word.

select(selectionMode?: Word.SelectionMode): void;

Параметры

selectionMode: Word.SelectionMode

Необязательный параметр. Режим выбора должен быть "Select", "Start" или "End". Значение по умолчанию — Select.

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/scroll-to-range.yaml

await Word.run(async (context) => {
  // If select is called with no parameters, it selects the object.
  context.document.body.paragraphs.getLast().select();

  await context.sync();
});

...

await Word.run(async (context) => {
  // Select can be at the start or end of a range; this by definition moves the insertion point without selecting the range.
  context.document.body.paragraphs.getLast().select(Word.SelectionMode.end);

  await context.sync();
});

select(selectionModeString)

Выбирает абзац и переходит к нему в пользовательском интерфейсе Word.

select(selectionModeString?: "Select" | "Start" | "End"): void;

Параметры

selectionModeString: "Select" | "Start" | "End"

Необязательный параметр. Режим выбора должен быть "Select", "Start" или "End". Значение по умолчанию — Select.

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

void

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Word.Interfaces.ParagraphUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/multiple-property-set.yaml

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  paragraph.set({
    leftIndent: 30,
    font: {
      bold: true,
      color: "red"
    }
  });

  await context.sync();
});

...

await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  const secondParagraph: Word.Paragraph = firstParagraph.getNext();
  firstParagraph.load("text, font/color, font/bold, leftIndent");

  await context.sync();

  secondParagraph.set(firstParagraph);

  await context.sync();
});

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.Paragraph): void;

Параметры

properties: Word.Paragraph

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

void

split(delimiters, trimDelimiters, trimSpacing)

Разделяет абзац на дочерние диапазоны с помощью разделителей.

split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection;

Параметры

delimiters: string[]

Обязательно. Разделители в виде массива строк.

trimDelimiters: boolean

Необязательный параметр. Указывает, следует ли обрезать разделители из диапазонов в коллекции диапазонов. Значение по умолчанию равно false, указывающее, что разделители включены в диапазоны, возвращаемые в коллекции диапазонов.

trimSpacing: boolean

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

Word.RangeCollection

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/split-words-of-first-paragraph.yaml

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  const words = paragraph.split([" "], true /* trimDelimiters*/, true /* trimSpaces */);
  words.load("text");

  await context.sync();

  for (let i = 0; i < words.items.length; i++) {
    if (i >= 1) {
      words.items[i - 1].font.highlightColor = "#FFFFFF";
    }
    words.items[i].font.highlightColor = "#FFFF00";

    await context.sync();
    await pause(200);
  }
});

startNewList()

Создает список, начинающийся с данного абзаца. Если абзац уже является элементом списка, метод не выполняется.

startNewList(): Word.List;

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

Word.List

Примеры

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

toJSON()

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

toJSON(): Word.Interfaces.ParagraphData;

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

Word.Interfaces.ParagraphData

track()

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

track(): Word.Paragraph;

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

Word.Paragraph

untrack()

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

untrack(): Word.Paragraph;

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

Word.Paragraph

Сведения о событии

onCommentAdded

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Происходит при добавлении новых комментариев.

readonly onCommentAdded: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentChanged

Примечание

Происходит при изменении комментария или его ответа.

readonly onCommentChanged: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentDeleted

Примечание

Происходит при удалении комментариев.

readonly onCommentDeleted: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentDeselected

Примечание

Происходит при отмене выбора комментария.

readonly onCommentDeselected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentSelected

Примечание

Происходит при выборе комментария.

readonly onCommentSelected: OfficeExtension.EventHandlers<Word.CommentEventArgs>;

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

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

Word.Paragraph class

Комментарии

Примеры

Свойства

Методы

События

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

alignment

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

Комментарии

Примеры

contentControls

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

Комментарии

context

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

endnotes

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

Комментарии

fields

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

Комментарии

firstLineIndent

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

Комментарии

font

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

Комментарии

footnotes

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

Комментарии

inlinePictures

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

Комментарии

isLastParagraph

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

Комментарии

isListItem

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

Комментарии

leftIndent

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

Комментарии

Примеры

lineSpacing

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

Комментарии

Примеры

lineUnitAfter

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

Комментарии

Примеры

lineUnitBefore

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

Комментарии

Примеры

list

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

Комментарии

listItem

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

Комментарии

listItemOrNullObject

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

Комментарии

listOrNullObject

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

Комментарии

outlineLevel

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

Комментарии

parentBody

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

Комментарии

parentContentControl

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

Комментарии

parentContentControlOrNullObject

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