Word.Paragraph class

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

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

// Reads the first paragraph's text.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    firstParagraph.load("text");
    await context.sync();
    console.log(`First paragraph: ${firstParagraph.text}`);
});

Свойства

alignment	Выравнивание абзаца. Значение может быть следующим : `left`, `rightcentered`, или .`justified`
borders	Возвращает `BorderUniversalCollection` объект, представляющий все границы абзаца.
contentControls	Получает коллекцию `ContentControl` объектов в абзаце.
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 для абзаца. Если абзац не является частью списка, этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
listOrNullObject	Возвращает объект List, к которому относится абзац. Если абзаца нет в списке, этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
outlineLevel	Определяет уровень структуры абзаца.
parentBody	Возвращает родительский текст абзаца.
parentContentControl	Возвращает элемент управления содержимым, содержащий абзац. Выдает ошибку, `ItemNotFound` если родительский элемент управления содержимым отсутствует.
parentContentControlOrNullObject	Возвращает элемент управления содержимым, содержащий абзац. Если родительский элемент управления содержимым отсутствует, этот метод возвращает объект со `isNullObject` свойством `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTable	Возвращает таблицу, содержащую абзац. Выдает `ItemNotFound` ошибку, если она не содержится в таблице.
parentTableCell	Возвращает ячейку таблицы, содержащую абзац. Выдает ошибку, `ItemNotFound` если она не содержится в ячейке таблицы.
parentTableCellOrNullObject	Возвращает ячейку таблицы, содержащую абзац. Если он не содержится в ячейке таблицы, этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTableOrNullObject	Возвращает таблицу, содержащую абзац. Если его нет в таблице, этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
rightIndent	Задает правильное значение отступа абзаца (в пунктах).
shading	Возвращает `ShadingUniversal` объект, который ссылается на форматирование заливки абзаца.
shapes	Получает коллекцию объектов, закрепленных `Shape` в абзаце, включая встроенные и плавающие фигуры. В настоящее время поддерживаются только следующие фигуры: надписи, геометрические фигуры, группы, рисунки и холсты.
spaceAfter	Интервал после абзаца (в точках).
spaceBefore	Интервал (в точках) перед абзацем.
style	Задает имя стиля абзаца. Используйте это свойство для пользовательских стилей и локализованных имен стилей. Чтобы использовать встроенные стили, поддерживающие несколько языковых стандартов, применяйте свойство styleBuiltIn.
styleBuiltIn	Задает встроенное имя стиля для абзаца. Используйте это свойство для встроенных стилей, поддерживающих несколько языковых стандартов. Чтобы использовать пользовательские стили или локализованные имена стилей, применяйте свойство style.
tableNestingLevel	Возвращает уровень таблицы, содержащей абзац. Возвращает 0, если абзац не находится в таблице.
text	Возвращает текст абзаца.
uniqueLocalId	Получает строку, представляющую идентификатор абзаца в текущем сеансе. Идентификатор имеет стандартный формат GUID 8-4-4-4-12 без фигурных скобок и отличается в зависимости от сеанса и соавтора.

Методы

attachToList(listId, level)	Позволяет присоединить абзац к существующему списку на указанном уровне. Если присоединить абзац к списку не удается или он уже является элементом списка, метод не выполняется.
clear()	Очищает содержимое `Paragraph` объекта. Пользователь может отменить операцию для очищенного содержимого.
closeUp()	Удаляются все интервалы перед абзацем.
delete()	Удаляет абзац и его содержимое из документа.
detachFromList()	Перемещает абзац за пределы списка (если он является элементом списка).
getAnnotations()	Получает заметки, заданные для этого `Paragraph` объекта.
getComments()	Получает комментарии, связанные с абзацем.
getContentControls(options)	Получает поддерживаемые в настоящее время элементы управления содержимым в абзаце.
getHtml()	Получает HTML-представление `Paragraph` объекта. При визуализации на веб-странице или в средстве просмотра HTML форматирование будет близко, но не точно, соответствовать форматированию документа. Этот метод не возвращает один и тот же HTML-код для одного и того же документа на разных платформах (Windows, Mac, Word в Интернете и т. д.). Если вам требуется точная точность или согласованность платформ, используйте `Paragraph.getOoxml()` и преобразуйте возвращенный XML-файл в HTML.
getNext()	Возвращает следующий абзац. Выдает ошибку, `ItemNotFound` если абзац является последним.
getNextOrNullObject()	Возвращает следующий абзац. Если абзац последний, то этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getOoxml()	Получает представление `Paragraph` объекта Office Open XML (OOXML).
getPrevious()	Возвращает предыдущий абзац. Выдает ошибку, `ItemNotFound` если абзац является первым.
getPreviousOrNullObject()	Возвращает предыдущий абзац. Если абзац является первым, то этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRange(rangeLocation)	Возвращает весь абзац (либо его начальную или конечную точку) в виде диапазона.
getReviewedText(changeTrackingVersion)	Получает проверенный текст на `ChangeTrackingVersion` основе выделения.
getReviewedText(changeTrackingVersion)	Получает проверенный текст на `ChangeTrackingVersion` основе выделения.
getText(options)	Возвращает текст абзаца. Сюда не включаются уравнения, графика (например, изображения, видео, рисунки) и специальные символы, которыми помечено различное содержимое (например, элементы управления содержимым, поля, комментарии, сноски, концевые сноски). По умолчанию скрытый текст и текст, помеченный как удаленный, исключаются.
getTextRanges(endingMarks, trimSpacing)	Получает текстовые диапазоны в абзаце с помощью знаков препинания и других концовок.
getTrackedChanges()	Получает коллекцию `TrackedChange` объектов в абзаце.
indent()	Отступ абзаца на один уровень.
indentCharacterWidth(count)	Отступ абзаца на указанное количество знаков.
indentFirstLineCharacterWidth(count)	Отступ первой строки абзаца на указанное количество знаков.
insertAnnotations(annotations)	Вставляет заметки к этому `Paragraph` объекту.
insertBreak(breakType, insertLocation)	Вставляет разрыв в указанном расположении в основном документе.
insertCanvas(insertShapeOptions)	Вставляет плавающий холст перед текстом с привязкой в начале абзаца.
insertContentControl(contentControlType)	Заключает `Paragraph` объект в оболочку элемента управления содержимым.
insertFileFromBase64(base64File, insertLocation)	Вставляет документ в абзац в указанном месте. Максимальный размер вставляемого документа составляет 4 МБ.
insertGeometricShape(geometricShapeType, insertShapeOptions)	Вставляет геометрическую фигуру перед текстом с привязкой в начале абзаца.
insertGeometricShape(geometricShapeType, insertShapeOptions)	Вставляет геометрическую фигуру перед текстом с привязкой в начале абзаца.
insertHtml(html, insertLocation)	Вставляет HTML в абзац в указанном расположении.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Вставляет рисунок в абзац в указанном расположении.
insertOoxml(ooxml, insertLocation)	Вставляет OOXML в абзац в указанном месте.
insertParagraph(paragraphText, insertLocation)	Вставляет абзац в указанном расположении.
insertPictureFromBase64(base64EncodedImage, insertShapeOptions)	Вставляет перед текстом плавающий рисунок с привязкой в начале абзаца.
insertTable(rowCount, columnCount, insertLocation, values)	Вставляет таблицу с указанным количеством строк и столбцов.
insertText(text, insertLocation)	Вставляет текст в абзац в указанном расположении.
insertTextBox(text, insertShapeOptions)	Вставляет плавающее текстовое поле перед текстом с привязкой в начале абзаца.
joinList()	Объединяет абзац списка, ближайший список выше или ниже этого абзаца. Этот метод работает только с маркированными, а не нумерованными списками.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
next(count)	Возвращает объект, `Paragraph` представляющий следующий абзац.
openOrCloseUp()	Включает интервал перед абзацем.
openUp()	Интервал перед абзацем равен 12 точкам.
outdent()	Удаляет один уровень отступа для абзаца.
outlineDemote()	Применение стиля следующего уровня заголовка (от заголовка 1 до заголовка 8) к абзацу.
outlineDemoteToBody()	Понижение абзаца до основного текста путем применения стиля "Обычный".
outlinePromote()	Применение предыдущего стиля уровня заголовка (от заголовка 1 до заголовка 8) к абзацу.
previous(count)	Возвращает предыдущий абзац в виде `Paragraph` объекта.
reset()	Удаляет ручное форматирование абзаца (форматирование не применяется с помощью стиля).
resetAdvanceTo()	Сбрасывает параметры абзаца, в котором используются пользовательские уровни списка, до исходного уровня.
search(searchText, searchOptions)	Выполняет поиск с заданными параметрами `Paragraph` поиска в области объекта. Результаты поиска представляют собой набор `Range` объектов.
select(selectionMode)	Выбирает абзац и переходит к нему в пользовательском интерфейсе Word.
select(selectionMode)	Выбирает абзац и переходит к нему в пользовательском интерфейсе Word.
selectNumber()	Выделение числа или маркера в списке.
separateList()	Разделяет список на два списка. Нумерованные списки могут начать нумерованную нумерацию заново с начального номера, обычно с 1.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
space1()	Установка одинарного интервала в абзаце.
space1Pt5()	Установка полуторного межстрочного интервала в абзаце.
space2()	Установка двойного интервала в абзаце.
split(delimiters, trimDelimiters, trimSpacing)	Разделяет абзац на дочерние диапазоны с помощью разделителей.
startNewList()	Создает список, начинающийся с данного абзаца. Если абзац уже является элементом списка, метод не выполняется.
tabHangingIndent(count)	Устанавливает выступ на указанное количество позиций табуляции.
tabIndent(count)	Задает левый отступ абзаца на указанное количество позиций табуляции.
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, rightcentered, или .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

// Centers the last paragraph between the document margins.
await Word.run(async (context) => {
  const lastParagraph: Word.Paragraph = context.document.body.paragraphs.getLast();
  const alignment: Word.Alignment = Word.Alignment.centered;
  lastParagraph.alignment = alignment;

  await context.sync();
});

borders

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

readonly borders: Word.BorderUniversalCollection;

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

Word.BorderUniversalCollection

Примеры

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

if (!Office.context.requirements.isSetSupported("WordApiDesktop", "1.3")) {
  console.error("This sample requires WordApiDesktop 1.3 or later.");
  return;
}

await Word.run(async (context) => {
  // Insert a paragraph at the beginning of the document.
  const paragraph: Word.Paragraph =
    context.document.body.insertParagraph(
      "Note: Added a border to this paragraph.",
      Word.InsertLocation.start
    );

  // Load the paragraph borders so they can be formatted.
  const borders: Word.BorderUniversalCollection = paragraph.borders;
  borders.load("items");
  await context.sync();

  // Apply a visible double blue line to every side of the paragraph.
  borders.items.forEach((border: Word.BorderUniversal) => {
    border.isVisible = true;
    border.color = "#4472C4";
    border.lineStyle = Word.BorderLineStyle.double;
    border.lineWidth = Word.LineWidth.pt150;
  });

  await context.sync();

  console.log(
    `Applied the ${Word.BorderLineStyle.double} line style to ${borders.items.length} paragraph borders.`
  );
});

contentControls

Получает коллекцию ContentControl объектов в абзаце.

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

Примеры

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

// Indents only the first line of the first paragraph.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.firstLineIndent = 36;
  await context.sync();
});

font

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

readonly font: Word.Font;

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

Word.Font

Примеры

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

if (!Office.context.requirements.isSetSupported("WordApiDesktop", "1.3")) {
  console.error("This sample requires WordApiDesktop 1.3 or later.");
  return;
}

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.insertParagraph(
    "Beveled text",
    Word.InsertLocation.start,
  );
  paragraph.font.size = 48;
  paragraph.font.bold = true;

  const threeDimensionalFormat: Word.ThreeDimensionalFormat = paragraph.font.threeDimensionalFormat;
  threeDimensionalFormat.isVisible = true;
  threeDimensionalFormat.bevelTopType = Word.BevelType.circle;
  threeDimensionalFormat.bevelTopDepth = 6;
  threeDimensionalFormat.bevelTopInset = 6;
  threeDimensionalFormat.load("bevelTopType,bevelTopDepth,bevelTopInset");

  await context.sync();

  console.log("Applied bevel formatting:", {
    type: threeDimensionalFormat.bevelTopType,
    depth: threeDimensionalFormat.bevelTopDepth,
    inset: threeDimensionalFormat.bevelTopInset,
  });
});

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

// Indents the first paragraph from the left margin.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.leftIndent = 75;

  await 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

// Adjusts the spacing between lines in the first paragraph.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.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

// Adds space after the first paragraph, measured in grid lines.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.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

// Adds space before the last paragraph, measured in grid lines.
await Word.run(async (context) => {
  const lastParagraph: Word.Paragraph = context.document.body.paragraphs.getLast();
  lastParagraph.lineUnitBefore = 1;

  await context.sync();
});

list

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

readonly list: Word.List;

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

Word.List

listItem

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

readonly listItem: Word.ListItem;

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

Word.ListItem

Примеры

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

// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const list: Word.List = paragraphs.items[0].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 numbering for list level 1.
  list.setLevelNumbering(0, Word.ListNumbering.arabic);

  // Set bullet type for list level 5.
  list.setLevelBullet(4, Word.ListBullet.arrow);

  // Set list level for the last item in this list.
  paragraph.listItem.level = 4;

  list.load("levelTypes");

  await context.sync();
});

listItemOrNullObject

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

readonly listItemOrNullObject: Word.ListItem;

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

Word.ListItem

listOrNullObject

Возвращает объект List, к которому относится абзац. Если абзаца нет в списке, этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *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

Возвращает элемент управления содержимым, содержащий абзац. Если родительский элемент управления содержимым отсутствует, этот метод возвращает объект со isNullObject свойством true. Дополнительные сведения см. в разделе Методы и свойства *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

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

readonly parentTableOrNullObject: Word.Table;

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

Word.Table

rightIndent

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

rightIndent: number;

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

number

Примеры

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

// Narrows the first paragraph by adding a right indent.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.rightIndent = 72;
  await context.sync();
});

shading

Возвращает ShadingUniversal объект, который ссылается на форматирование заливки абзаца.

readonly shading: Word.ShadingUniversal;

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

Word.ShadingUniversal

shapes

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

readonly shapes: Word.ShapeCollection;

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

Word.ShapeCollection

spaceAfter

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

spaceAfter: number;

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

number

Примеры

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

// Adds space after the first paragraph, measured in points.
await Word.run(async (context) => {
  const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
  firstParagraph.spaceAfter = 20;

  await context.sync();
});

spaceBefore

Интервал (в точках) перед абзацем.

spaceBefore: number;

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

number

Примеры

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

// Adds space before the last paragraph, measured in points.
await Word.run(async (context) => {
  const lastParagraph: Word.Paragraph = context.document.body.paragraphs.getLast();
  lastParagraph.spaceBefore = 24;
  await context.sync();
});

style

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

style: string;

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

string

Примеры

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

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

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load("isNullObject, nameLocal, type");
  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();
    const paragraph: Word.Paragraph = body.insertParagraph(
      "This paragraph uses a custom style.",
      Word.InsertLocation.start
    );
    paragraph.style = style.nameLocal;
    await context.sync();

    console.log(`Applied '${styleName}' to the sample 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(`The first paragraph of the selected text: ${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()

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

clear(): void;

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

void

Примеры

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

// Removes the first paragraph's content but keeps the paragraph.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    firstParagraph.clear();
    await context.sync();
    console.log("Cleared the first paragraph. Its empty paragraph remains.");
});

closeUp()

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

closeUp(): void;

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

void

delete()

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

delete(): void;

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

void

Примеры

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

// Removes the first paragraph and its content from the document.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    firstParagraph.delete();
    await context.sync();
    console.log("Deleted the first paragraph and its content.");
});

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

getHtml(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Примеры

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

// Reads an HTML representation of the first paragraph.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const html: OfficeExtension.ClientResult<string> = firstParagraph.getHtml();
    await context.sync();
    console.log(`Paragraph HTML: ${html.value}`);
});

getNext()

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

getNext(): Word.Paragraph;

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

Word.Paragraph

Примеры

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

// Reads the paragraph immediately after the first paragraph.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const nextParagraph: Word.Paragraph = firstParagraph.getNext();
    nextParagraph.load("text");
    await context.sync();
    console.log(`Next paragraph: ${nextParagraph.text}`);
});

getNextOrNullObject()

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

getNextOrNullObject(): Word.Paragraph;

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

Word.Paragraph

Примеры

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

// Checks for a following paragraph without throwing at the end of the body.
await Word.run(async (context) => {
    const lastParagraph: Word.Paragraph = context.document.body.paragraphs.getLast();
    const nextParagraph: Word.Paragraph = lastParagraph.getNextOrNullObject();
    nextParagraph.load("text");
    await context.sync();
    if (nextParagraph.isNullObject) {
        console.log("There is no paragraph after the last paragraph.");
    } else {
        console.log(`Next paragraph: ${nextParagraph.text}`);
    }
});

getOoxml()

Получает представление Paragraph объекта Office Open XML (OOXML).

getOoxml(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Примеры

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

// Reads the first paragraph's Office Open XML representation.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const ooxml: OfficeExtension.ClientResult<string> = firstParagraph.getOoxml();
    await context.sync();
    console.log(`Paragraph OOXML: ${ooxml.value}`);
});

getPrevious()

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

getPrevious(): Word.Paragraph;

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

Word.Paragraph

Примеры

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

// Reads the paragraph immediately before the last paragraph.
await Word.run(async (context) => {
    const lastParagraph: Word.Paragraph = context.document.body.paragraphs.getLast();
    const previousParagraph: Word.Paragraph = lastParagraph.getPrevious();
    previousParagraph.load("text");
    await context.sync();
    console.log(`Previous paragraph: ${previousParagraph.text}`);
});

getPreviousOrNullObject()

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

getPreviousOrNullObject(): Word.Paragraph;

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

Word.Paragraph

Примеры

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

// Checks for a preceding paragraph without throwing at the start of the body.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const previousParagraph: Word.Paragraph = firstParagraph.getPreviousOrNullObject();
    previousParagraph.load("text");
    await context.sync();
    if (previousParagraph.isNullObject) {
        console.log("There is no paragraph before the first paragraph.");
    } else {
        console.log(`Previous paragraph: ${previousParagraph.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,afterend , , или .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

// Gets complete sentences from the insertion point to the end of its paragraph.
await Word.run(async (context) => {
  const selection: Word.Range = context.document.getSelection();
  const sentences: Word.RangeCollection = selection.getTextRanges(["."], false);
  sentences.load("$none");
  await context.sync();

  const firstSentence: Word.Range = sentences.items[0];
  const paragraphEnd: Word.Range = selection.paragraphs.getFirst().getRange(Word.RangeLocation.end);
  const remainingRange: Word.Range = firstSentence.expandTo(paragraphEnd);
  const sentencesToTheEndOfParagraph: Word.RangeCollection = remainingRange.getTextRanges(["."], false);
  sentencesToTheEndOfParagraph.load("text");
  await context.sync();

  console.log("Sentences from the current sentence to the paragraph end:");
  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

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

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

OfficeExtension.ClientResult<string>

getReviewedText(changeTrackingVersion)

Получает проверенный текст на ChangeTrackingVersion основе выделения.

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

Параметры

changeTrackingVersion: "Original" | "Current"

Необязательный параметр. Значение должно быть или originalcurrent. Значение по умолчанию — 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>

Примеры

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

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();

  const text = paragraph.getText();
  const textIncludingHidden = paragraph.getText({ IncludeHiddenText: true });
  const textIncludingDeleted = paragraph.getText({ IncludeTextMarkedAsDeleted: true });

  await context.sync();

  console.log(`Text: ${text.value}`);
  console.log(`Including hidden text: ${textIncludingHidden.value}`);
  console.log(`Including text marked as deleted: ${textIncludingDeleted.value}`);
});

getTextRanges(endingMarks, trimSpacing)

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

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

Параметры

endingMarks: string[]

Знаки препинания и другие знаки переназначения в виде массива строк.

trimSpacing: boolean

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

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

Word.RangeCollection

Примеры

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

// Reads sentence ranges delimited by periods in the first paragraph.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const sentences: Word.RangeCollection = firstParagraph.getTextRanges(["."], true);
    sentences.load("items/text");
    await context.sync();
    console.log(`Sentences found: ${sentences.items.length}`);
    for (const sentence of sentences.items) {
        console.log(`Sentence: ${sentence.text}`);
    }
});

getTrackedChanges()

Получает коллекцию TrackedChange объектов в абзаце.

getTrackedChanges(): Word.TrackedChangeCollection;

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

Word.TrackedChangeCollection

indent()

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

indent(): void;

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

void

indentCharacterWidth(count)

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

indentCharacterWidth(count: number): void;

Параметры

count: number

Количество знаков для отступа.

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

void

indentFirstLineCharacterWidth(count)

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

indentFirstLineCharacterWidth(count: number): void;

Параметры

count: number

Количество знаков для отступа первой строки.

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

void

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"

Значение должно быть или beforeafter.

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

void

Примеры

// 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("Inserted a line break after the first paragraph.");
});

insertCanvas(insertShapeOptions)

Вставляет плавающий холст перед текстом с привязкой в начале абзаца.

insertCanvas(insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Параметры

insertShapeOptions: Word.InsertShapeOptions

Необязательный параметр. Расположение и размер холста. Расположение и размер по умолчанию: (0, 0, 300, 200).

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

Word.Shape

insertContentControl(contentControlType)

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

insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | Word.ContentControlType.buildingBlockGallery | Word.ContentControlType.datePicker | Word.ContentControlType.repeatingSection | Word.ContentControlType.picture | Word.ContentControlType.group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"): Word.ContentControl;

Параметры

contentControlType: richText | plainText | checkBox | dropDownList | comboBox | buildingBlockGallery | datePicker | repeatingSection | picture | group | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox" | "BuildingBlockGallery" | "DatePicker" | "RepeatingSection" | "Picture" | "Group"

Необязательный параметр. Тип элемента управления содержимым для вставки. Должен быть , richTextplainText, checkBox, dropDownList,comboBox , buildingBlockGallerypicturerepeatingSectiondatePickerили .group Значение по умолчанию — richText.

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

Word.ContentControl

Примечание. Параметр contentControlType был добавлен в WordApi 1.5. plainText Поддержка была добавлена в WordApi 1.5. checkBox поддержка была добавлена в WordApi 1.7. dropDownList поддержка comboBox была добавлена в WordApi 1.9. Поддержка buildingBlockGallery,datePicker ,group , picture, и repeatingSection была добавлена в WordApiDesktop 1.3.

Примеры

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

Вставляет документ в абзац в указанном месте. Максимальный размер вставляемого документа составляет 4 МБ.

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 (скорее всего, в поле формы). Рассмотрите возможность замены такого поля формы элементом управления содержимым или другим подходящим для вашего сценария параметром.

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

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

insertGeometricShape(geometricShapeType, insertShapeOptions)

Вставляет геометрическую фигуру перед текстом с привязкой в начале абзаца.

insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Параметры

geometricShapeType: Word.GeometricShapeType

Геометрический тип вставляемой фигуры.

insertShapeOptions: Word.InsertShapeOptions

Необязательный параметр. Расположение и размер геометрической фигуры. Расположение и размер по умолчанию: (0, 0, 100, 100).

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

Word.Shape

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/group-ungroup.yaml

await Word.run(async (context) => {
  const body: Word.Body = context.document.body;
  body.clear();
  const lastParagraph: Word.Paragraph = body.paragraphs.getLast();

  // Inserts a text box.
  const textBoxOptions: Word.InsertShapeOptions = {
    top: 0,
    left: 0,
    height: 100,
    width: 100,
  };
  lastParagraph.insertTextBox("placeholder text", textBoxOptions);

  // Inserts a geometric shape.
  const geometricShapeOptions: Word.InsertShapeOptions = {
    height: 120,
    width: 120,
    left: 120,
  };
  lastParagraph.insertGeometricShape(Word.GeometricShapeType.star24, geometricShapeOptions);

  // Inserts a picture.
  const pictureOptions: Word.InsertShapeOptions = {
    top: 120,
    left: 60,
    height: 150,
    width: 150,
  };
  lastParagraph.insertPictureFromBase64(getPictureBase64(), pictureOptions);

  await context.sync();
});

insertGeometricShape(geometricShapeType, insertShapeOptions)

Вставляет геометрическую фигуру перед текстом с привязкой в начале абзаца.

insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Параметры

geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"

Геометрический тип вставляемой фигуры.

insertShapeOptions: Word.InsertShapeOptions

Необязательный параметр. Расположение и размер геометрической фигуры. Расположение и размер по умолчанию: (0, 0, 100, 100).

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

Word.Shape

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

Примеры

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

// Replaces the first paragraph's content with bold and italic text from HTML.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const insertedRange: Word.Range = firstParagraph.insertHtml(
        "<b>Project update:</b> <i>ready for review.</i>",
        Word.InsertLocation.replace
    );
    await context.sync();
    console.log("Replaced the first paragraph's content with formatted HTML.");
});

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

Примеры

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

// Replaces the first paragraph's content with a bold update from an OOXML package.
await Word.run(async (context) => {
    const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
    const ooxml: string =
        `<pkg:package xmlns:pkg="http://schemas.microsoft.com/office/2006/xmlPackage">
            <pkg:part pkg:name="/_rels/.rels" pkg:contentType="application/vnd.openxmlformats-package.relationships+xml">
                <pkg:xmlData><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
                    <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="word/document.xml"/>
                </Relationships></pkg:xmlData>
            </pkg:part>
            <pkg:part pkg:name="/word/document.xml" pkg:contentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml">
                <pkg:xmlData><w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
                    <w:body><w:p><w:r><w:rPr><w:b/></w:rPr><w:t>Project update from OOXML.</w:t></w:r></w:p></w:body>
                </w:document></pkg:xmlData>
            </pkg:part>
        </pkg:package>`;
    const insertedRange: Word.Range = firstParagraph.insertOoxml(ooxml, Word.InsertLocation.replace);
    await context.sync();
    console.log("Replaced the first paragraph's content with a bold OOXML update.");
});

insertParagraph(paragraphText, insertLocation)

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

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

Параметры

paragraphText: string

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

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

Значение должно быть или beforeafter.

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

Word.Paragraph

Примеры

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

insertPictureFromBase64(base64EncodedImage, insertShapeOptions)

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

insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Параметры

base64EncodedImage: string

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

insertShapeOptions: Word.InsertShapeOptions

Необязательный параметр. Расположение и размер рисунка. Расположение по умолчанию — (0, 0), а размер по умолчанию равен исходному размеру изображения.

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

Word.Shape

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"

Значение должно быть или beforeafter.

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

insertTextBox(text, insertShapeOptions)

Вставляет плавающее текстовое поле перед текстом с привязкой в начале абзаца.

insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;

Параметры

text: string

Необязательный параметр. Текст, вставляемый в текстовое поле.

insertShapeOptions: Word.InsertShapeOptions

Необязательный параметр. Расположение и размер текстового поля. Расположение и размер по умолчанию: (0, 0, 100, 100).

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

Word.Shape

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml

await Word.run(async (context) => {
  // Inserts a text box at the beginning of the first paragraph in the header.
  const headerFooterBody: Word.Body = context.document.sections.getFirst().getHeader(Word.HeaderFooterType.primary);
  headerFooterBody.load("paragraphs");
  const firstParagraph: Word.Paragraph = headerFooterBody.paragraphs.getFirst();
  const insertShapeOptions: Word.InsertShapeOptions = {
    top: 0,
    left: 0,
    height: 100,
    width: 100
  };
  const newTextBox: Word.Shape = firstParagraph.insertTextBox("placeholder text", insertShapeOptions);
  newTextBox.select();
  await context.sync();

  console.log("Inserted a text box at the beginning of the first paragraph in the header.");
});

joinList()

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

joinList(): void;

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

void

load(options)

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

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

Параметры

options: Word.Interfaces.ParagraphLoadOptions

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

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

Word.Paragraph

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

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

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

Word.Paragraph

load(propertyNamesAndPaths)

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

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

Параметры

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

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

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

Word.Paragraph

next(count)

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

next(count: number): Word.Paragraph;

Параметры

count: number

previous(count: number): Word.Paragraph;

Параметры

count: number

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

Необязательный параметр. Режим выделения должен быть , selectstartили .end select используется по умолчанию.

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

void

Примеры

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

// Selects the final paragraph and scrolls it into view.
await Word.run(async (context) => {
  const lastRange: Word.Range = context.document.body.paragraphs.getLast().getRange();
  lastRange.select();

  await context.sync();
});

...

// Moves the insertion point to the end of the final paragraph.
await Word.run(async (context) => {
  const lastRange: Word.Range = context.document.body.paragraphs.getLast().getRange();
  const selectionMode: Word.SelectionMode = Word.SelectionMode.end;
  lastRange.select(selectionMode);

  await context.sync();
});

select(selectionMode)

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

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

Параметры

selectionMode: "Select" | "Start" | "End"

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

Параметры

properties: Word.Interfaces.ParagraphUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

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

space1()

Установка одинарного интервала в абзаце.

space1(): void;

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

void

space1Pt5()

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

space1Pt5(): void;

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

void

space2()

Установка двойного интервала в абзаце.

space2(): void;

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

void

split(delimiters, trimDelimiters, trimSpacing)

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

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

Параметры

delimiters: string[]

Разделители в виде массива строк.

trimDelimiters: boolean

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

trimSpacing: boolean

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

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

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

// Splits the first paragraph into words and highlights them in sequence.
await Word.run(async (context) => {
  const paragraphRange: Word.Range = context.document.body.paragraphs.getFirst().getRange();
  const words: Word.RangeCollection = paragraphRange.split([" "], false, true, true);
  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 new Promise((resolve) => setTimeout(resolve, 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.
  const listItem: Word.ListItem = paragraph.listItem;
  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();
});

tabHangingIndent(count)

Устанавливает выступ на указанное количество позиций табуляции.

tabHangingIndent(count: number): void;

Параметры

count: number

Количество позиций табуляции для выступа.

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

void

tabIndent(count)

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

tabIndent(count: number): void;

Параметры

count: number

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

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

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

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentChanged

Примечание

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

Возникает при изменении комментария или ответа.

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

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentDeleted

Примечание

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

Возникает при удалении примечаний.

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

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentDeselected

Примечание

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

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

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

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentSelected

Примечание

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

Возникает при выборе комментария.

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

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

Комментарии

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

Примеры

Свойства

Методы

События

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

alignment

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

Комментарии

Примеры

borders

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

Комментарии

Примеры

contentControls

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

Комментарии

context

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

endnotes

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

Комментарии

fields

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

Комментарии

firstLineIndent

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

Комментарии

Примеры

font

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

Комментарии

Примеры

footnotes

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

Комментарии

inlinePictures

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

Комментарии

isLastParagraph

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

Комментарии

isListItem

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

Комментарии

leftIndent

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

Комментарии

Примеры

lineSpacing

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

Комментарии

Примеры

lineUnitAfter

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

Комментарии

Примеры

lineUnitBefore

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

Комментарии

Примеры

list

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

Комментарии

listItem

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

Комментарии

Примеры

listItemOrNullObject

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

Комментарии

listOrNullObject

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

Комментарии

outlineLevel

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

Комментарии

parentBody