Word.Range class

Ссылка

Пакет:: word

Представляет непрерывную область в документе.

Extends: OfficeExtension.ClientObject

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

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
  comment.load("contentRange");
  const range: Word.Range = comment.getRange();
  range.load("text");
  await context.sync();

  if (comment.isNullObject) {
    console.warn("No comments in the selection, so no range to get.");
    return;
  }

  console.log(`Comment location: ${range.text}`);
  const contentRange: Word.CommentContentRange = comment.contentRange;
  console.log("Comment content range:", contentRange);
});

Свойства

contentControls	Возвращает коллекцию объектов элементов управления содержимым в диапазоне.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
endnotes	Возвращает коллекцию концевых сносок в диапазоне.
fields	Возвращает коллекцию объектов полей в диапазоне.
font	Возвращает формат текста диапазона. Используйте это свойство, чтобы получать и задавать имея, размер, цвет и другие свойства шрифта.
footnotes	Возвращает коллекцию сносок в диапазоне.
hyperlink	Возвращает первую гиперссылку в диапазоне или задает для него гиперссылку. При добавлении в диапазон новой гиперссылки из него удаляются все имеющиеся гиперссылки. Используйте "#", чтобы отделить адресную часть от необязательной части расположения.
inlinePictures	Возвращает коллекцию объектов встроенных рисунков в диапазоне.
isEmpty	Проверяет, является ли длина диапазона нулевой.
lists	Возвращает коллекцию объектов списков в диапазоне.
paragraphs	Возвращает коллекцию объектов абзаца в диапазоне.
parentBody	Возвращает родительский текст диапазона.
parentContentControl	Возвращает поддерживаемый в настоящее время элемент управления содержимым, содержащий диапазон. Выдает ошибку `ItemNotFound` , если родительского элемента управления содержимым нет.
parentContentControlOrNullObject	Возвращает поддерживаемый в настоящее время элемент управления содержимым, содержащий диапазон. Если родительского элемента управления содержимым нет, этот метод вернет объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTable	Возвращает таблицу, содержащую диапазон. Выдает ошибку `ItemNotFound` , если она не содержится в таблице.
parentTableCell	Возвращает ячейку таблицы, содержащую диапазон. Выдает ошибку `ItemNotFound` , если она не содержится в ячейке таблицы.
parentTableCellOrNullObject	Возвращает ячейку таблицы, содержащую диапазон. Если он не содержится в ячейке таблицы, этот метод вернет объект со свойством , для него `isNullObject` задано значение `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTableOrNullObject	Возвращает таблицу, содержащую диапазон. Если он не содержится в таблице, то этот метод вернет объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
style	Задает имя стиля для диапазона. Используйте это свойство для пользовательских стилей и локализованных имен стилей. Чтобы использовать встроенные стили, поддерживающие несколько языковых стандартов, применяйте свойство styleBuiltIn.
styleBuiltIn	Задает встроенное имя стиля для диапазона. Используйте это свойство для встроенных стилей, поддерживающих несколько языковых стандартов. Чтобы использовать пользовательские стили или локализованные имена стилей, применяйте свойство style.
tables	Возвращает коллекцию объектов таблиц в диапазоне.
text	Возвращает текст диапазона.

Методы

clear()	Очищает содержимое объекта диапазона. Пользователь может отменить операцию для очищенного содержимого.
compareLocationWith(range)	Сравнивает расположение данного диапазона с расположением другого диапазона.
delete()	Удаляет диапазон и его содержимое из документа.
expandTo(range)	Возвращает новый диапазон, который простирается в том или ином направлении от данного диапазона и перекрывает другой диапазон. Этот диапазон не изменяется. Выдает ошибку `ItemNotFound` , если два диапазона не имеют объединения.
expandToOrNullObject(range)	Возвращает новый диапазон, который простирается в том или ином направлении от данного диапазона и перекрывает другой диапазон. Этот диапазон не изменяется. Если два диапазона не имеют объединения, то этот метод вернет объект со свойством `isNullObject` , имеющим значение `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getBookmarks(includeHidden, includeAdjacent)	Возвращает имена всех закладок в диапазоне или перекрывающих его. Закладка скрыта, если ее имя начинается с символа подчеркивания.
getComments()	Возвращает комментарии, связанные с диапазоном.
getContentControls(options)	Возвращает поддерживаемые в настоящее время элементы управления содержимым в диапазоне.
getHtml()	Возвращает HTML-представление объекта диапазона. При отображении на веб-странице или в средстве просмотра HTML форматирование будет близко, но не точно совпадает с форматированием документа. Этот метод не возвращает один и тот же HTML-код для одного документа на разных платформах (Windows, Mac, Word в Интернете и т. д.). Если вам нужна точную точность или согласованность на разных платформах, используйте `Range.getOoxml()` и преобразуйте возвращенный XML-код в HTML.
getHyperlinkRanges()	Возвращает дочерние диапазоны гиперссылок в данном диапазоне.
getNextTextRange(endingMarks, trimSpacing)	Возвращает следующий текстовый диапазон с помощью знаков препинания и (или) других конечных знаков. Выдает ошибку, `ItemNotFound` если этот текстовый диапазон является последним.
getNextTextRangeOrNullObject(endingMarks, trimSpacing)	Возвращает следующий текстовый диапазон с помощью знаков препинания и (или) других конечных знаков. Если этот текстовый диапазон является последним, то этот метод вернет объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getOoxml()	Возвращает OOXML-представление объекта диапазона.
getRange(rangeLocation)	Клонирует диапазон либо получает его начальную или конечную точку в виде нового диапазона.
getReviewedText(changeTrackingVersion)	Возвращает проверенный текст на основе выбора ChangeTrackingVersion.
getReviewedText(changeTrackingVersionString)	Возвращает проверенный текст на основе выбора ChangeTrackingVersion.
getTextRanges(endingMarks, trimSpacing)	Возвращает текстовые дочерние диапазоны в диапазоне с помощью знаков препинания и (или) других конечных знаков.
getTrackedChanges()	Возвращает коллекцию объектов TrackedChange в диапазоне.
highlight()	Временно выделяет диапазон без изменения содержимого документа. Чтобы выделить текст без возможности восстановления, задайте для диапазона значение Font.HighlightColor.
insertBookmark(name)	Вставляет закладку в диапазон. Если закладка с таким же именем где-то существует, она сначала удаляется.
insertBreak(breakType, insertLocation)	Вставляет разрыв в указанном расположении в основном документе.
insertComment(commentText)	Вставьте комментарий в диапазон.
insertContentControl(contentControlType)	Заключает объект Range в элемент управления содержимым.
insertEndnote(insertText)	Вставляет концевую сноску. После диапазона размещается ссылка на концевую сноску.
insertField(insertLocation, fieldType, text, removeFormatting)	Вставляет поле в указанное расположение.
insertField(insertLocation, fieldTypeString, text, removeFormatting)	Вставляет поле в указанное расположение.
insertFileFromBase64(base64File, insertLocation)	Вставляет документ в указанном расположении.
insertFootnote(insertText)	Вставляет сноску. Ссылка на сноску помещается после диапазона.
insertHtml(html, insertLocation)	Вставляет HTML-код в указанном расположении.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Вставляет рисунок в указанном расположении.
insertOoxml(ooxml, insertLocation)	Вставляет OOXML-код в указанном расположении.
insertParagraph(paragraphText, insertLocation)	Вставляет абзац в указанном расположении.
insertTable(rowCount, columnCount, insertLocation, values)	Вставляет таблицу с указанным количеством строк и столбцов.
insertText(text, insertLocation)	Вставляет текст в заданном расположении.
intersectWith(range)	Возвращает новый диапазон, представляющий собой пересечение данного диапазона с другим. Этот диапазон не изменяется. Выдает ошибку, `ItemNotFound` если два диапазона не перекрываются или не соседствуют.
intersectWithOrNullObject(range)	Возвращает новый диапазон, представляющий собой пересечение данного диапазона с другим. Этот диапазон не изменяется. Если два диапазона не перекрываются или не соседствуют друг с другом, этот метод вернет объект со свойством , для которых `isNullObject` задано значение `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
removeHighlight()	Удаляет выделение, добавленное функцией "Выделить", если таковой есть.
search(searchText, searchOptions)	Выполняет поиск с указанным searchOptions в область объекта диапазона. Результат поиска — это коллекция объектов диапазона.
select(selectionMode)	Выбор диапазона и переход к нему в пользовательском интерфейсе Word.
select(selectionModeString)	Выбор диапазона и переход к нему в пользовательском интерфейсе Word.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)	Разделяет диапазон на дочерние диапазоны с помощью разделителей.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.Range` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Word.Interfaces.RangeData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах `.sync` и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить `context.sync()` до того, как выпуск памяти вступит в силу.

События

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

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

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

font

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

readonly font: Word.Font;

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

Word.Font

footnotes

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

readonly footnotes: Word.NoteItemCollection;

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

Word.NoteItemCollection

Примеры

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

// Gets the footnotes in the selected document range.
await Word.run(async (context) => {
  const footnotes: Word.NoteItemCollection = context.document.getSelection().footnotes;
  footnotes.load("length");
  await context.sync();

  console.log("Number of footnotes in the selected range: " + footnotes.items.length);
});

hyperlink

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

hyperlink: string;

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

string

inlinePictures

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

readonly inlinePictures: Word.InlinePictureCollection;

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

Word.InlinePictureCollection

isEmpty

Проверяет, является ли длина диапазона нулевой.

readonly isEmpty: boolean;

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

boolean

lists

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

readonly lists: Word.ListCollection;

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

Word.ListCollection

paragraphs

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

readonly paragraphs: Word.ParagraphCollection;

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

Word.ParagraphCollection

Важно! Для наборов требований 1.1 и 1.2 абзацы в таблицах, которые содержатся в этом диапазоне, не возвращаются. Из набора обязательных элементов 1.3 также возвращаются абзацы в таких таблицах.

parentBody

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

readonly parentBody: Word.Body;

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

Word.Body

parentContentControl

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

readonly parentContentControl: Word.ContentControl;

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

Word.ContentControl

Примеры

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

// Toggles the isChecked property of the first checkbox content control found in the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.checkBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id,checkboxContentControl/isChecked");

  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type,checkboxContentControl/isChecked");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
      console.warn("No checkbox content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  const isCheckedBefore = selectedContentControl.checkboxContentControl.isChecked;
  console.log("isChecked state before:", `id: ${selectedContentControl.id} ... isChecked: ${isCheckedBefore}`);
  selectedContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
  selectedContentControl.load("id,checkboxContentControl/isChecked");
  await context.sync();

  console.log(
    "isChecked state after:",
    `id: ${selectedContentControl.id} ... isChecked: ${selectedContentControl.checkboxContentControl.isChecked}`
  );
});

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

style

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

style: string;

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

string

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 header: Word.Range = context.document.body.insertText("This is a sample Heading 1 Title!!\n",
        "Start" /*this means at the beginning of the body */);
    header.styleBuiltIn = Word.BuiltInStyleName.heading1;

    await context.sync();
});

tables

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

readonly tables: Word.TableCollection;

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

Word.TableCollection

text

Возвращает текст диапазона.

readonly text: string;

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

string

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

clear()

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

clear(): void;

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

void

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to clear the contents of the proxy range object.
    range.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 selection (range object)');
});

compareLocationWith(range)

Сравнивает расположение данного диапазона с расположением другого диапазона.

compareLocationWith(range: Word.Range): OfficeExtension.ClientResult<Word.LocationRelation>;

Параметры

range: Word.Range

Обязательно. Диапазон для сравнения с этим диапазоном.

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

OfficeExtension.ClientResult<Word.LocationRelation>

Примеры

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

// Compares the location of one paragraph in relation to another paragraph.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("items");

  await context.sync();

  const firstParagraphAsRange: Word.Range = paragraphs.items[0].getRange();
  const secondParagraphAsRange: Word.Range = paragraphs.items[1].getRange();

  const comparedLocation = firstParagraphAsRange.compareLocationWith(secondParagraphAsRange);

  await context.sync();

  const locationValue: Word.LocationRelation = comparedLocation.value;
  console.log(`Location of the first paragraph in relation to the second paragraph: ${locationValue}`);
});

delete()

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

delete(): void;

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

void

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to delete the range object.
    range.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 selection (range object)');
});

expandTo(range)

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

expandTo(range: Word.Range): Word.Range;

Параметры

range: Word.Range

Обязательно. Другой диапазон.

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

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

expandToOrNullObject(range)

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

expandToOrNullObject(range: Word.Range): Word.Range;

Параметры

range: Word.Range

Обязательно. Другой диапазон.

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

Word.Range

getBookmarks(includeHidden, includeAdjacent)

Возвращает имена всех закладок в диапазоне или перекрывающих его. Закладка скрыта, если ее имя начинается с символа подчеркивания.

getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean): OfficeExtension.ClientResult<string[]>;

Параметры

includeHidden: boolean

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

includeAdjacent: boolean

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

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

OfficeExtension.ClientResult<string[]>

getComments()

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

getComments(): Word.CommentCollection;

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

Word.CommentCollection

Примеры

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

// Gets the comments in the selected content.
await Word.run(async (context) => {
  const comments: Word.CommentCollection = context.document.getSelection().getComments();

  // Load objects to log in the console.
  comments.load();
  await context.sync();

  console.log("Comments:", comments);
});

getContentControls(options)

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

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

Параметры

options: Word.ContentControlOptions

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

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

Word.ContentControlCollection

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

Примеры

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

// Deletes the first checkbox content control found in the selection.
await Word.run(async (context) => {
  const selectedRange: Word.Range = context.document.getSelection();
  let selectedContentControl = selectedRange
    .getContentControls({
      types: [Word.ContentControlType.checkBox]
    })
    .getFirstOrNullObject();
  selectedContentControl.load("id");

  await context.sync();

  if (selectedContentControl.isNullObject) {
    const parentContentControl: Word.ContentControl = selectedRange.parentContentControl;
    parentContentControl.load("id,type");
    await context.sync();

    if (parentContentControl.isNullObject || parentContentControl.type !== Word.ContentControlType.checkBox) {
      console.warn("No checkbox content control is currently selected.");
      return;
    } else {
      selectedContentControl = parentContentControl;
    }
  }

  console.log(`About to delete checkbox content control with id: ${selectedContentControl.id}`);
  selectedContentControl.delete(false);
  await context.sync();

  console.log("Deleted checkbox content control.");
});

getHtml()

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

getHtml(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to get the HTML of the current selection.
    const html = range.getHtml();

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

getHyperlinkRanges()

Возвращает дочерние диапазоны гиперссылок в данном диапазоне.

getHyperlinkRanges(): Word.RangeCollection;

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

Word.RangeCollection

Примеры

await Word.run(async (context) => {
    // Get the entire document body.
    const bodyRange = context.document.body.getRange(Word.RangeLocation.whole);

    // Get all the ranges that only consist of hyperlinks.
    const hyperLinks = bodyRange.getHyperlinkRanges();
    hyperLinks.load("hyperlink");
    await context.sync();

    // Log each hyperlink.
    hyperLinks.items.forEach((linkRange) => {
        console.log(linkRange.hyperlink);
    });
});

getNextTextRange(endingMarks, trimSpacing)

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

getNextTextRange(endingMarks: string[], trimSpacing?: boolean): Word.Range;

Параметры

endingMarks: string[]

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

trimSpacing: boolean

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

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

Word.Range

getNextTextRangeOrNullObject(endingMarks, trimSpacing)

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

getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean): Word.Range;

Параметры

endingMarks: string[]

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

trimSpacing: boolean

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

Word.Range

getOoxml()

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

getOoxml(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to get the OOXML of the current selection.
    const ooxml = range.getOoxml();

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

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/10-content-controls/insert-and-change-dropdown-list-content-control.yaml

// Places a dropdown list content control at the end of the selection.
await Word.run(async (context) => {
  let selection = context.document.getSelection();
  selection.getRange(Word.RangeLocation.end).insertContentControl(Word.ContentControlType.dropDownList);
  await context.sync();

  console.log("Dropdown list content control inserted at the end of the selection.");
});

getReviewedText(changeTrackingVersion)

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

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

Параметры

changeTrackingVersion: Word.ChangeTrackingVersion

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

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

OfficeExtension.ClientResult<string>

Примеры

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

// Gets the reviewed text.
await Word.run(async (context) => {
  const range: Word.Range = context.document.getSelection();
  const before = range.getReviewedText(Word.ChangeTrackingVersion.original);
  const after = range.getReviewedText(Word.ChangeTrackingVersion.current);

  await context.sync();

  console.log("Reviewed text (before):", before.value, "Reviewed text (after):", after.value);
});

getReviewedText(changeTrackingVersionString)

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

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

Параметры

changeTrackingVersionString: "Original" | "Current"

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

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

OfficeExtension.ClientResult<string>

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

getTrackedChanges()

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

getTrackedChanges(): Word.TrackedChangeCollection;

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

Word.TrackedChangeCollection

highlight()

Временно выделяет диапазон без изменения содержимого документа. Чтобы выделить текст без возможности восстановления, задайте для диапазона значение Font.HighlightColor.

highlight(): void;

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

void

insertBookmark(name)

Вставляет закладку в диапазон. Если закладка с таким же именем где-то существует, она сначала удаляется.

insertBookmark(name: string): void;

Параметры

name: string

Обязательно. Имя закладки без учета регистра. Поддерживаются только буквенно-цифровые символы и символы подчеркивания. Он должен начинаться с буквы, но если вы хотите пометить закладку как скрытую, то имя должно начинаться с символа подчеркивания. Имена не могут быть длиннее 40 символов.

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

void

Примечание. Условия вставки закладки аналогичны условиям в пользовательском интерфейсе Word. Дополнительные сведения об управлении закладками в пользовательском интерфейсе Word см. в статье Добавление и удаление закладок в документе Word или сообщении Outlook.

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) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert a page break after the selected text.
    range.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 selected text.');
});

insertComment(commentText)

Вставьте комментарий в диапазон.

insertComment(commentText: string): Word.Comment;

Параметры

commentText: string

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

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

Word.Comment

объект comment

Примеры

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

// Sets a comment on the selected content.
await Word.run(async (context) => {
  const text = $("#comment-text")
    .val()
    .toString();
  const comment: Word.Comment = context.document.getSelection().insertComment(text);

  // Load object to log in the console.
  comment.load();
  await context.sync();

  console.log("Comment inserted:", comment);
});

insertContentControl(contentControlType)

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

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.

Примеры

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

// Simulates creation of a template. First searches the document for instances of the string "Contractor",
// then changes the format  of each search result,
// then wraps each search result within a content control,
// finally sets a tag and title property on each content control.
await Word.run(async (context) => {
    const results: Word.RangeCollection = context.document.body.search("Contractor");
    results.load("font/bold");

    // Check to make sure these content controls haven't been added yet.
    const customerContentControls: Word.ContentControlCollection = context.document.contentControls.getByTag("customer");
    customerContentControls.load("text");
    await context.sync();

  if (customerContentControls.items.length === 0) {
    for (let i = 0; i < results.items.length; i++) { 
        results.items[i].font.bold = true;
        let cc: Word.ContentControl = results.items[i].insertContentControl();
        cc.tag = "customer";  // This value is used in the next step of this sample.
        cc.title = "Customer Name " + i;
    }
  }
    await context.sync();
});

insertEndnote(insertText)

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

insertEndnote(insertText?: string): Word.NoteItem;

Параметры

insertText: string

Необязательный параметр. Текст, вставляемый в текст концевой сноски. Значение по умолчанию — "".

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

Word.NoteItem

insertField(insertLocation, fieldType, text, removeFormatting)

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

insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean): Word.Field;

Параметры

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

Обязательно. Расположение относительно диапазона, в который будет вставлено поле. Значение должно быть "Replace", "Start", "End", "Before" или "After".

fieldType: Word.FieldType

Необязательный параметр. Может быть любой константой FieldType. Значение по умолчанию — Empty.

text: string

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

removeFormatting: boolean

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

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

Word.Field

Примеры

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

// Inserts a Date field before selection.
await Word.run(async (context) => {
  const range: Word.Range = context.document.getSelection().getRange();

  const field: Word.Field = range.insertField(Word.InsertLocation.before, Word.FieldType.date, '\\@ "M/d/yyyy h:mm am/pm"', true);

  field.load("result,code");
  await context.sync();

  if (field.isNullObject) {
    console.log("There are no fields in this document.");
  } else {
    console.log("Code of the field: " + field.code, "Result of the field: " + JSON.stringify(field.result));
  }
});

insertField(insertLocation, fieldTypeString, text, removeFormatting)

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

insertField(insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After", fieldTypeString?: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined", text?: string, removeFormatting?: boolean): Word.Field;

Параметры

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

fieldTypeString: "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"

Необязательный параметр. Может быть любой константой FieldType. Значение по умолчанию — Empty.

text: string

removeFormatting: boolean

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

Word.Field

insertFileFromBase64(base64File, insertLocation)

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

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Параметры

base64File: string

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

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

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

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

Word.Range

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

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert base64 encoded .docx at the beginning of the range.
    // You'll need to implement getBase64() to make this work.
    range.insertFileFromBase64(getBase64(), 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 base64 encoded text to the beginning of the range.');
});

insertFootnote(insertText)

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

insertFootnote(insertText?: string): Word.NoteItem;

Параметры

insertText: string

Необязательный параметр. Текст, вставляемый в текст сноски. Значение по умолчанию — "".

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

Word.NoteItem

Примеры

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

// Sets a footnote on the selected content.
await Word.run(async (context) => {
  const text = $("#input-footnote")
    .val()
    .toString();
  const footnote: Word.NoteItem = context.document.getSelection().insertFootnote(text);
  await context.sync();

  console.log("Inserted footnote.");
});

insertHtml(html, insertLocation)

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

insertHtml(html: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Параметры

html: string

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

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

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

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

Word.Range

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert HTML in to the beginning of the range.
    range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', 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('HTML added to the beginning of the range.');
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

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

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.InlinePicture;

Параметры

base64EncodedImage: string

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

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

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

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

Word.InlinePicture

insertOoxml(ooxml, insertLocation)

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

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"): Word.Range;

Параметры

ooxml: string

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

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

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

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

Word.Range

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert OOXML in to the beginning of the range.
    range.insertOoxml("<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:padding='512'><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:pPr><w:spacing w:before='360' w:after='0' w:line='480' w:lineRule='auto'/><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr></w:pPr><w:r><w:rPr><w:color w:val='70AD47' w:themeColor='accent6'/><w:sz w:val='28'/></w:rPr><w:t>This text has formatting directly applied to achieve its font size, color, line spacing, and paragraph spacing.</w:t></w:r></w:p></w:body></w:document></pkg:xmlData></pkg:part></pkg:package>", 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('OOXML added to the beginning of the range.');
});

// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml

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

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert the paragraph after the range.
    range.insertParagraph('Content of a new paragraph', 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('Paragraph added to the end of the range.');
});

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" | "Start" | "End" | "Before" | "After"): Word.Range;

Параметры

text: string

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

insertLocation: Word.InsertLocation | "Replace" | "Start" | "End" | "Before" | "After"

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

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

Word.Range

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert the paragraph at the end of the range.
    range.insertText('New text inserted into the range.', 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('Text added to the end of the range.');
});

intersectWith(range)

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

intersectWith(range: Word.Range): Word.Range;

Параметры

range: Word.Range

Обязательно. Другой диапазон.

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

Word.Range

intersectWithOrNullObject(range)

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

intersectWithOrNullObject(range: Word.Range): Word.Range;

Параметры

range: Word.Range

Обязательно. Другой диапазон.

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

Word.Range

load(options)

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

load(options?: Word.Interfaces.RangeLoadOptions): Word.Range;

Параметры

options: Word.Interfaces.RangeLoadOptions

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

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

Word.Range

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Word.Range

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Word.Range

removeHighlight()

Удаляет выделение, добавленное функцией "Выделить", если таковой есть.

removeHighlight(): void;

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

void

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

Примеры

// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Queue a command to get the current selection and then
    // create a proxy range object with the results.
    const range = context.document.getSelection();

    // Queue a command to insert HTML in to the beginning of the range.
    range.insertHtml('<strong>This is text inserted with range.insertHtml()</strong>', Word.InsertLocation.start);

    // Queue a command to select the HTML that was inserted.
    range.select();

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

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.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Word.Interfaces.RangeUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.Range): void;

Параметры

properties: Word.Range

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

void

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

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

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

Параметры

delimiters: string[]

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

multiParagraphs: boolean

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

trimDelimiters: boolean

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

trimSpacing: boolean

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

Word.RangeCollection

toJSON()

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

toJSON(): Word.Interfaces.RangeData;

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

Word.Interfaces.RangeData

track()

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

track(): Word.Range;

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

Word.Range

untrack()

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

untrack(): Word.Range;

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

Word.Range

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

onCommentAdded

Примечание

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

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

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

Тип события

OfficeExtension.EventHandlers<Word.CommentEventArgs>

onCommentChanged

Примечание

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

readonly onCommentChanged: 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.Range class

Комментарии

Примеры

Свойства

Методы

События

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

contentControls

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

Комментарии

context

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

endnotes

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

Комментарии

fields

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

Комментарии

font

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

Комментарии

footnotes

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

Комментарии

Примеры

hyperlink

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

Комментарии

inlinePictures

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

Комментарии

isEmpty

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

Комментарии

lists

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

Комментарии

paragraphs

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

Комментарии

parentBody

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

Комментарии

parentContentControl

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

Комментарии

Примеры

parentContentControlOrNullObject

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

Комментарии

parentTable

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

Комментарии

parentTableCell

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

Комментарии

parentTableCellOrNullObject

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

Комментарии

parentTableOrNullObject

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

Комментарии

style

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

Комментарии

styleBuiltIn

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

Комментарии

Примеры

tables

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

Комментарии

text

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

Комментарии

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

clear()

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

Комментарии