Word.ContentControl class

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

[Набор API: WordApi 1.1]

Extends

Свойства

appearance

Получает или задает внешний вид элемента управления содержимым. Значение может быть "BoundingBox", "Tags" или "Hidden".

[Набор API: WordApi 1.1]

cannotDelete

Возвращает или задает значение, указывающее, может ли пользователь удалить элемент управления содержимым. Является взаимоисключающим со свойством removeWhenEdited.

[Набор API: WordApi 1.1]

cannotEdit

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

[Набор API: WordApi 1.1]

color

Возвращает или задает цвет элемента управления содержимым. Цвет указывается в формате # RRGGBB или с помощью имени цвета.

[Набор API: WordApi 1.1]

contentControls

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

[Набор API: WordApi 1.1]

context

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

font

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

[Набор API: WordApi 1.1]

id

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

[Набор API: WordApi 1.1]

inlinePictures

Получает коллекцию объектов inlinePicture в элементе управления содержимым. Коллекция не содержит плавающие рисунки. Только для чтения.

[Набор API: WordApi 1.1]

lists

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

[Набор API: WordApi 1.3]

paragraphs

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

[Набор API: WordApi 1.1]

parentBody

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

[Набор API: WordApi 1.3]

parentContentControl

Получает элемент управления содержимым, содержащий элемент управления содержимым. Если нет родительского управления контентом, ошибка. Только для чтения.

[Набор API: WordApi 1.1]

parentContentControlOrNullObject

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

[Набор API: WordApi 1.3]

parentTable

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

[Набор API: WordApi 1.3]

parentTableCell

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

[Набор API: WordApi 1.3]

parentTableCellOrNullObject

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

[Набор API: WordApi 1.3]

parentTableOrNullObject

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

[Набор API: WordApi 1.3]

placeholderText

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

Примечание. Заданной операции для этого свойства не поддерживается в Word в Интернете.

[Набор API: WordApi 1.1]

removeWhenEdited

Возвращает или задает значение, указывающее, удаляется ли элемент управления содержимым после изменения. Является взаимоисключающим со свойством cannotDelete.

[Набор API: WordApi 1.1]

style

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

[Набор API: WordApi 1.1]

styleBuiltIn

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

[Набор API: WordApi 1.3]

subtype

Возвращает подтип элемента управления содержимым. Поддерживаемые подтипы: RichTextInline, RichTextParagraphs, RichTextTableCell, RichTextTableRow и RichTextTable для элементов управления форматированным текстом. Только для чтения.

[Набор API: WordApi 1.3]

tables

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

[Набор API: WordApi 1.3]

tag

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

[Набор API: WordApi 1.1]

text

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

[Набор API: WordApi 1.1]

title

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

[Набор API: WordApi 1.1]

type

Получает тип элемента управления содержимым. На данный момент поддерживаются только элементы управления содержимым в формате RTF. Только для чтения.

[Набор API: WordApi 1.1]

Методы

clear()

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

[Набор API: WordApi 1.1]

delete(keepContent)

Удаляет элемент управления содержимым и его содержимое. Если свойство keepContent имеет значение true, содержимое не будет удалено.

[Набор API: WordApi 1.1]

getHtml()

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

[Набор API: WordApi 1.1]

getOoxml()

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

[Набор API: WordApi 1.1]

getRange(rangeLocation)

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

[Набор API: WordApi 1.3]

getRange(rangeLocationString)

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

[Набор API: WordApi 1.3]

getTextRanges(endingMarks, trimSpacing)

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

[Набор API: WordApi 1.3]

insertBreak(breakType, insertLocation)

Вставляет разрыв в указанном расположении в основном документе. Этот метод нельзя использовать с помощью элементов управления контентом RichTextTable, RichTextTableRow и RichTextTableCell.

[Набор API: WordApi 1.1]

insertBreak(breakTypeString, insertLocation)

Вставляет разрыв в указанном расположении в основном документе. Этот метод нельзя использовать с помощью элементов управления контентом RichTextTable, RichTextTableRow и RichTextTableCell.

[Набор API: WordApi 1.1]

insertFileFromBase64(base64File, insertLocation)

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

[Набор API: WordApi 1.1]

insertFileFromBase64(base64File, insertLocationString)

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

[Набор API: WordApi 1.1]

insertHtml(html, insertLocation)

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

[Набор API: WordApi 1.1]

insertHtml(html, insertLocationString)

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

[Набор API: WordApi 1.1]

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

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

[Набор API: WordApi 1.2]

insertInlinePictureFromBase64(base64EncodedImage, insertLocationString)

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

[Набор API: WordApi 1.2]

insertOoxml(ooxml, insertLocation)

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

[Набор API: WordApi 1.1]

insertOoxml(ooxml, insertLocationString)

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

[Набор API: WordApi 1.1]

insertParagraph(paragraphText, insertLocation)

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

[Набор API: WordApi 1.1]

insertParagraph(paragraphText, insertLocationString)

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

[Набор API: WordApi 1.1]

insertTable(rowCount, columnCount, insertLocation, values)

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

[Набор API: WordApi 1.3]

insertTable(rowCount, columnCount, insertLocationString, values)

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

[Набор API: WordApi 1.3]

insertText(text, insertLocation)

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

[Набор API: WordApi 1.1]

insertText(text, insertLocationString)

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

[Набор API: WordApi 1.1]

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

search(searchText, searchOptions)

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

[Набор API: WordApi 1.1]

select(selectionMode)

Выбирает элемент управления контентом. При этом Word переходит к выделенному фрагменту.

[Набор API: WordApi 1.1]

select(selectionModeString)

Выбирает элемент управления контентом. При этом Word переходит к выделенному фрагменту.

[Набор API: WordApi 1.1]

set(properties, options)

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

set(properties)

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

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

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

[Набор API: WordApi 1.3]

toJSON()

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

track()

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

untrack()

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

События

onDataChanged

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

[API set: WordApi BETA (PREVIEW ONLY)]

onDeleted

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

[API set: WordApi BETA (PREVIEW ONLY)]

onSelectionChanged

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

[API set: WordApi BETA (PREVIEW ONLY)]

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

appearance

Получает или задает внешний вид элемента управления содержимым. Значение может быть "BoundingBox", "Tags" или "Hidden".

[Набор API: WordApi 1.1]

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

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

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

cannotDelete

Возвращает или задает значение, указывающее, может ли пользователь удалить элемент управления содержимым. Является взаимоисключающим со свойством removeWhenEdited.

[Набор API: WordApi 1.1]

cannotDelete: boolean;

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

boolean

cannotEdit

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

[Набор API: WordApi 1.1]

cannotEdit: boolean;

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

boolean

color

Возвращает или задает цвет элемента управления содержимым. Цвет указывается в формате # RRGGBB или с помощью имени цвета.

[Набор API: WordApi 1.1]

color: string;

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

string

contentControls

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

[Набор API: WordApi 1.1]

readonly contentControls: Word.ContentControlCollection;

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

context

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

context: RequestContext;

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

font

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

[Набор API: WordApi 1.1]

readonly font: Word.Font;

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

id

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

[Набор API: WordApi 1.1]

readonly id: number;

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

number

inlinePictures

Получает коллекцию объектов inlinePicture в элементе управления содержимым. Коллекция не содержит плавающие рисунки. Только для чтения.

[Набор API: WordApi 1.1]

readonly inlinePictures: Word.InlinePictureCollection;

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

lists

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

[Набор API: WordApi 1.3]

readonly lists: Word.ListCollection;

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

paragraphs

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

[Набор API: WordApi 1.1]

readonly paragraphs: Word.ParagraphCollection;

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

parentBody

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

[Набор API: WordApi 1.3]

readonly parentBody: Word.Body;

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

parentContentControl

Получает элемент управления содержимым, содержащий элемент управления содержимым. Если нет родительского управления контентом, ошибка. Только для чтения.

[Набор API: WordApi 1.1]

readonly parentContentControl: Word.ContentControl;

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

parentContentControlOrNullObject

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

[Набор API: WordApi 1.3]

readonly parentContentControlOrNullObject: Word.ContentControl;

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

parentTable

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

[Набор API: WordApi 1.3]

readonly parentTable: Word.Table;

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

parentTableCell

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

[Набор API: WordApi 1.3]

readonly parentTableCell: Word.TableCell;

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

parentTableCellOrNullObject

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

[Набор API: WordApi 1.3]

readonly parentTableCellOrNullObject: Word.TableCell;

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

parentTableOrNullObject

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

[Набор API: WordApi 1.3]

readonly parentTableOrNullObject: Word.Table;

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

placeholderText

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

Примечание. Заданной операции для этого свойства не поддерживается в Word в Интернете.

[Набор API: WordApi 1.1]

placeholderText: string;

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

string

removeWhenEdited

Возвращает или задает значение, указывающее, удаляется ли элемент управления содержимым после изменения. Является взаимоисключающим со свойством cannotDelete.

[Набор API: WordApi 1.1]

removeWhenEdited: boolean;

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

boolean

style

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

[Набор API: WordApi 1.1]

style: string;

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

string

styleBuiltIn

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

[Набор API: WordApi 1.3]

styleBuiltIn: Word.Style | "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";

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

Word.Style | "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"

subtype

Возвращает подтип элемента управления содержимым. Поддерживаемые подтипы: RichTextInline, RichTextParagraphs, RichTextTableCell, RichTextTableRow и RichTextTable для элементов управления форматированным текстом. Только для чтения.

[Набор API: WordApi 1.3]

readonly subtype: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

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

Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText"

tables

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

[Набор API: WordApi 1.3]

readonly tables: Word.TableCollection;

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

tag

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

[Набор API: WordApi 1.1]

tag: string;

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

string

Примеры

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

text

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

[Набор API: WordApi 1.1]

readonly text: string;

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

string

title

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

[Набор API: WordApi 1.1]

title: string;

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

string

type

Получает тип элемента управления содержимым. На данный момент поддерживаются только элементы управления содержимым в формате RTF. Только для чтения.

[Набор API: WordApi 1.1]

readonly type: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

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

Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText"

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

clear()

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

[Набор API: WordApi 1.1]

clear(): void;

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

void

Примеры

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection.
    var contentControls = context.document.contentControls;
    
    // Queue a command to load the content controls collection.
    contentControls.load('text');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        
        if (contentControls.items.length === 0) {
            console.log("There isn't a content control in this document.");
        } else {
            
            // Queue a command to clear the contents of the first content control.
            contentControls.items[0].clear();
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync().then(function () {
                console.log('Content control cleared of contents.');
            });      
        }
            
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

delete(keepContent)

Удаляет элемент управления содержимым и его содержимое. Если свойство keepContent имеет значение true, содержимое не будет удалено.

[Набор API: WordApi 1.1]

delete(keepContent: boolean): void;

Параметры

keepContent

boolean

Обязательный параметр. Указывает, следует ли удалить содержимое вместе с элементом управления содержимым. Если свойству keepContent задано значение true, содержимое не удаляется.

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

void

Примеры

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection.
    var contentControls = context.document.contentControls;
    
    // Queue a command to load the content controls collection.
    contentControls.load('text');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        
        if (contentControls.items.length === 0) {
            console.log("There isn't a content control in this document.");
        } else {
            
            // Queue a command to delete the first content control. The
            // contents will remain in the document.
            contentControls.items[0].delete(true);
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync().then(function () {
                console.log('Content control cleared of contents.');
            });      
        }
            
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

getHtml()

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

[Набор API: WordApi 1.1]

getHtml(): OfficeExtension.ClientResult<string>;

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

Примеры

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection that contains a specific tag.
    var contentControlsWithTag = context.document.contentControls.getByTag('Customer-Address');
    
    // Queue a command to load the tag property for all of content controls. 
    context.load(contentControlsWithTag, 'tag');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        if (contentControlsWithTag.items.length === 0) {
            console.log('No content control found.');
        }
        else {
            // Queue a command to get the HTML contents of the first content control.
            var html = contentControlsWithTag.items[0].getHtml();
        
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync()
                .then(function () {
                    console.log('Content control HTML: ' + html.value);
            });
        }
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

getOoxml()

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

[Набор API: WordApi 1.1]

getOoxml(): OfficeExtension.ClientResult<string>;

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

Примеры

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection.
    var contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls. 
    context.load(contentControls, 'id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        if (contentControls.items.length === 0) {
            console.log('No content control found.');
        }
        else {
            // Queue a command to get the OOXML contents of the first content control.
            var ooxml = contentControls.items[0].getOoxml();
        
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync()
                .then(function () {
                    console.log('Content control OOXML: ' + ooxml.value);
            });
        }
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

getRange(rangeLocation)

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

[Набор API: WordApi 1.3]

getRange(rangeLocation?: Word.RangeLocation): Word.Range;

Параметры

rangeLocation
Word.RangeLocation

Необязательно. Расположение диапазона может быть "Whole", "Before", "Start", "End", "After" или "Content".

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

getRange(rangeLocationString)

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

[Набор API: WordApi 1.3]

getRange(rangeLocationString?: "Whole" | "Start" | "End" | "Before" | "After" | "Content"): Word.Range;

Параметры

rangeLocationString

"Whole" | "Start" | "End" | "Before" | "After" | "Content"

Необязательно. Расположение диапазона может быть "Whole", "Before", "Start", "End", "After" или "Content".

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

getTextRanges(endingMarks, trimSpacing)

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

[Набор API: WordApi 1.3]

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

Параметры

endingMarks

string[]

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

trimSpacing

boolean

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

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

insertBreak(breakType, insertLocation)

Вставляет разрыв в указанном расположении в основном документе. Этот метод нельзя использовать с помощью элементов управления контентом RichTextTable, RichTextTableRow и RichTextTableCell.

[Набор API: WordApi 1.1]

insertBreak(breakType: Word.BreakType, insertLocation: Word.InsertLocation): void;

Параметры

breakType
Word.BreakType

Обязательный. Тип перерыва.

insertLocation
Word.InsertLocation

Обязательный. Значение может быть "Начало", "Конец", "До" или "После".

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

void

insertBreak(breakTypeString, insertLocation)

Вставляет разрыв в указанном расположении в основном документе. Этот метод нельзя использовать с помощью элементов управления контентом RichTextTable, RichTextTableRow и RichTextTableCell.

[Набор API: WordApi 1.1]

insertBreak(breakTypeString: "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: "Before" | "After" | "Start" | "End" | "Replace"): void;

Параметры

breakTypeString

"Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

Обязательный. Тип перерыва.

insertLocation

"Before" | "After" | "Start" | "End" | "Replace"

Обязательный. Значение может быть "Начало", "Конец", "До" или "После".

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

void

Примеры

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection.
    var contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of content controls. 
    context.load(contentControls, 'id');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion. We now will have 
    // access to the content control collection.
    return context.sync().then(function () {
        if (contentControls.items.length === 0) {
            console.log('No content control found.');
        }
        else {
            // Queue a command to insert a page break after the first content control. 
            contentControls.items[0].insertBreak('page', "After");
            
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion. 
            return context.sync()
                .then(function () {
                    console.log('Inserted a page break after the first content control.');    
            });
        }
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

insertFileFromBase64(base64File, insertLocation)

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

[Набор API: WordApi 1.1]

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation): Word.Range;

Параметры

base64File

string

Обязательный. Кодированное содержимое файла .docx base64.

insertLocation
Word.InsertLocation

Обязательный параметр. Возможные значения: Replace, Start или End. 'Replace' нельзя использовать с помощью элементов управления контентом RichTextTable и RichTextTableRow.

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

insertFileFromBase64(base64File, insertLocationString)

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

[Набор API: WordApi 1.1]

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

Параметры

base64File

string

Обязательный. Кодированное содержимое файла .docx base64.

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Обязательный параметр. Возможные значения: Replace, Start или End. 'Replace' нельзя использовать с помощью элементов управления контентом RichTextTable и RichTextTableRow.

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

insertHtml(html, insertLocation)

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

[Набор API: WordApi 1.1]

insertHtml(html: string, insertLocation: Word.InsertLocation): Word.Range;

Параметры

html

string

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

insertLocation
Word.InsertLocation

Обязательный параметр. Возможные значения: Replace, Start или End. 'Replace' нельзя использовать с помощью элементов управления контентом RichTextTable и RichTextTableRow.

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

insertHtml(html, insertLocationString)

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

[Набор API: WordApi 1.1]

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

Параметры

html

string

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

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Обязательный параметр. Возможные значения: Replace, Start или End. 'Replace' нельзя использовать с помощью элементов управления контентом RichTextTable и RichTextTableRow.

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

Примеры

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection.
    var contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls. 
    context.load(contentControls, 'id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        if (contentControls.items.length === 0) {
            console.log('No content control found.');
        }
        else {
            // Queue a command to put HTML into the contents of the first content control.
            contentControls.items[0].insertHtml(
                '<strong>HTML content inserted into the content control.</strong>',
                'Start');
        
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync()
                .then(function () {
                    console.log('Inserted HTML in the first content control.');
            });
        }
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

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

[Набор API: WordApi 1.2]

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation): Word.InlinePicture;

Параметры

base64EncodedImage

string

Обязательный параметр. Вставляемое в элемент управления содержимым изображение в кодировке base64.

insertLocation
Word.InsertLocation

Обязательный параметр. Возможные значения: Replace, Start или End. 'Replace' нельзя использовать с помощью элементов управления контентом RichTextTable и RichTextTableRow.

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

insertInlinePictureFromBase64(base64EncodedImage, insertLocationString)

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

[Набор API: WordApi 1.2]

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

Параметры

base64EncodedImage

string

Обязательный параметр. Вставляемое в элемент управления содержимым изображение в кодировке base64.

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Обязательный параметр. Возможные значения: Replace, Start или End. 'Replace' нельзя использовать с помощью элементов управления контентом RichTextTable и RichTextTableRow.

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

insertOoxml(ooxml, insertLocation)

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

[Набор API: WordApi 1.1]

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation): Word.Range;

Параметры

ooxml

string

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

insertLocation
Word.InsertLocation

Обязательный параметр. Возможные значения: Replace, Start или End. 'Replace' нельзя использовать с помощью элементов управления контентом RichTextTable и RichTextTableRow.

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

insertOoxml(ooxml, insertLocationString)

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

[Набор API: WordApi 1.1]

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

Параметры

ooxml

string

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

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Обязательный параметр. Возможные значения: Replace, Start или End. 'Replace' нельзя использовать с помощью элементов управления контентом RichTextTable и RichTextTableRow.

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

Примеры

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection.
    var contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls. 
    context.load(contentControls, 'id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        if (contentControls.items.length === 0) {
            console.log('No content control found.');
        }
        else {
            // Queue a command to put OOXML into the contents of the first content control.
            contentControls.items[0].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>", "End");
        
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync()
                .then(function () {
                    console.log('Inserted OOXML in the first content control.');
            });
        }
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

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

insertParagraph(paragraphText, insertLocation)

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

[Набор API: WordApi 1.1]

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation): Word.Paragraph;

Параметры

paragraphText

string

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

insertLocation
Word.InsertLocation

Обязательный. Значение может быть "Начало", "Конец", "До" или "После". Элементы управления контентом RichTextTable, RichTextTable и RichTextTableRow нельзя использовать с помощью элементов управления контентом "Before" и "After".

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

insertParagraph(paragraphText, insertLocationString)

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

[Набор API: WordApi 1.1]

insertParagraph(paragraphText: string, insertLocationString: "Before" | "After" | "Start" | "End" | "Replace"): Word.Paragraph;

Параметры

paragraphText

string

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

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Обязательный. Значение может быть "Начало", "Конец", "До" или "После". Элементы управления контентом RichTextTable, RichTextTable и RichTextTableRow нельзя использовать с помощью элементов управления контентом "Before" и "After".

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

Примеры

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection.
    var contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls. 
    context.load(contentControls, 'id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        if (contentControls.items.length === 0) {
            console.log('No content control found.');
        }
        else {
            // Queue a command to insert a paragraph after the first content control. 
            contentControls.items[0].insertParagraph('Text of the inserted paragraph.', 'After');
        
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync()
                .then(function () {
                    console.log('Inserted a paragraph after the first content control.');
            });
        }
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

insertTable(rowCount, columnCount, insertLocation, values)

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

[Набор API: WordApi 1.3]

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation, values?: string[][]): Word.Table;

Параметры

rowCount

number

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

columnCount

number

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

insertLocation
Word.InsertLocation

Обязательный. Значение может быть "Начало", "Конец", "До" или "После". Элементы управления контентом RichTextTable, RichTextTable и RichTextTableRow нельзя использовать с помощью элементов управления контентом "Before" и "After".

values

string[][]

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

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

insertTable(rowCount, columnCount, insertLocationString, values)

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

[Набор API: WordApi 1.3]

insertTable(rowCount: number, columnCount: number, insertLocationString: "Before" | "After" | "Start" | "End" | "Replace", values?: string[][]): Word.Table;

Параметры

rowCount

number

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

columnCount

number

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

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Обязательный. Значение может быть "Начало", "Конец", "До" или "После". Элементы управления контентом RichTextTable, RichTextTable и RichTextTableRow нельзя использовать с помощью элементов управления контентом "Before" и "After".

values

string[][]

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

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

insertText(text, insertLocation)

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

[Набор API: WordApi 1.1]

insertText(text: string, insertLocation: Word.InsertLocation): Word.Range;

Параметры

text

string

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

insertLocation
Word.InsertLocation

Обязательный параметр. Возможные значения: Replace, Start или End. 'Replace' нельзя использовать с помощью элементов управления контентом RichTextTable и RichTextTableRow.

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

insertText(text, insertLocationString)

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

[Набор API: WordApi 1.1]

insertText(text: string, insertLocationString: "Before" | "After" | "Start" | "End" | "Replace"): Word.Range;

Параметры

text

string

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

insertLocationString

"Before" | "After" | "Start" | "End" | "Replace"

Обязательный параметр. Возможные значения: Replace, Start или End. 'Replace' нельзя использовать с помощью элементов управления контентом RichTextTable и RichTextTableRow.

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

Примеры

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection.
    var contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls. 
    context.load(contentControls, 'id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        if (contentControls.items.length === 0) {
            console.log('No content control found.');
        }
        else {
            // Queue a command to replace text in the first content control. 
            contentControls.items[0].insertText('Replaced text in the first content control.', 'Replace');
        
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync()
                .then(function () {
                    console.log('Replaced text in the first content control.');
            });
        }
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

// The Silly stories add-in sample shows how to use the insertText method.
// https://aka.ms/sillystorywordaddin

load(options)

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

load(options?: Word.Interfaces.ContentControlLoadOptions): Word.ContentControl;

Параметры

options
Word.Interfaces.ContentControlLoadOptions

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

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

Примеры

// Load all of the content control properties
// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection.
    var contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls. 
    context.load(contentControls, 'id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        if (contentControls.items.length === 0) {
            console.log('No content control found.');
        }
        else {
            // Queue a command to load the properties on the first content control. 
            contentControls.items[0].load(  'appearance,' +
                                            'cannotDelete,' +
                                            'cannotEdit,' +
                                            'id,' +
                                            'placeHolderText,' +
                                            'removeWhenEdited,' +
                                            'title,' +
                                            'text,' +
                                            'type,' +
                                            'style,' +
                                            'tag,' +
                                            'font/size,' +
                                            'font/name,' +
                                            'font/color');             
        
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync()
                .then(function () {
                    console.log('Property values of the first content control:' + 
                        '   ----- appearance: ' + contentControls.items[0].appearance + 
                        '   ----- cannotDelete: ' + contentControls.items[0].cannotDelete +
                        '   ----- cannotEdit: ' + contentControls.items[0].cannotEdit +
                        '   ----- color: ' + contentControls.items[0].color +
                        '   ----- id: ' + contentControls.items[0].id +
                        '   ----- placeHolderText: ' + contentControls.items[0].placeholderText +
                        '   ----- removeWhenEdited: ' + contentControls.items[0].removeWhenEdited +
                        '   ----- title: ' + contentControls.items[0].title +
                        '   ----- text: ' + contentControls.items[0].text +
                        '   ----- type: ' + contentControls.items[0].type +
                        '   ----- style: ' + contentControls.items[0].style +
                        '   ----- tag: ' + contentControls.items[0].tag +
                        '   ----- font size: ' + contentControls.items[0].font.size +
                        '   ----- font name: ' + contentControls.items[0].font.name +
                        '   ----- font color: ' + contentControls.items[0].font.color);
            });
        }
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select является запятой, которая указывает свойства для загрузки, и является строкой, запятой, которая указывает свойства навигации для propertyNamesAndPaths.expand загрузки.

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

search(searchText, searchOptions)

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

[Набор API: WordApi 1.1]

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

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

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

Примеры

// Run a batch operation against the Word object model.
Word.run(function (context) {
    
    // Create a proxy object for the content controls collection.
    var contentControls = context.document.contentControls;
    
    // Queue a command to load the id property for all of the content controls. 
    context.load(contentControls, 'id');
     
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    return context.sync().then(function () {
        if (contentControls.items.length === 0) {
            console.log('No content control found.');
        }
        else {
            // Queue a command to select the first content control.
            contentControls.items[0].select();
        
            // Synchronize the document state by executing the queued commands, 
            // and return a promise to indicate task completion.
            return context.sync()
                .then(function () {
                    console.log('Selected the first content control.');
            });
        }
    });  
})
.catch(function (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
});

select(selectionMode)

Выбирает элемент управления контентом. При этом Word переходит к выделенному фрагменту.

[Набор API: WordApi 1.1]

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

Параметры

selectionMode
Word.SelectionMode

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

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

void

select(selectionModeString)

Выбирает элемент управления контентом. При этом Word переходит к выделенному фрагменту.

[Набор API: WordApi 1.1]

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

Параметры

selectionModeString

"Select" | "Start" | "End"

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

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

void

set(properties, options)

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

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

Параметры

properties
Word.Interfaces.ContentControlUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

Комментарии

Этот метод имеет следующую дополнительную подпись:

set(properties: Word.ContentControl): void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-content-controls.yaml
// Adds title and colors to odd and even content controls and changes their appearance.
await Word.run(async (context) => {
  // Gets the complete sentence (as range) associated with the insertion point.
  let evenContentControls = context.document.contentControls.getByTag("even");
  let oddContentControls = context.document.contentControls.getByTag("odd");
  evenContentControls.load("length");
  oddContentControls.load("length");

  await context.sync();

  for (let i = 0; i < evenContentControls.items.length; i++) {
    // Change a few properties and append a paragraph
    evenContentControls.items[i].set({
      color: "red",
      title: "Odd ContentControl #" + (i + 1),
      appearance: "Tags"
    });
    evenContentControls.items[i].insertParagraph("This is an odd content control", "End");
  }

  for (let j = 0; j < oddContentControls.items.length; j++) {
    // Change a few properties and append a paragraph
    oddContentControls.items[j].set({
      color: "green",
      title: "Even ContentControl #" + (j + 1),
      appearance: "Tags"
    });
    oddContentControls.items[j].insertHtml("This is an <b>even</b> content control", "End");
  }

  await context.sync();
});

set(properties)

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

set(properties: Word.ContentControl): void;

Параметры

properties
Word.ContentControl

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

void

split(delimiters, multiParagraphs, trimDelimiters, trimSpacing)

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

[Набор API: WordApi 1.3]

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

Параметры

delimiters

string[]

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

multiParagraphs

boolean

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

trimDelimiters

boolean

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

trimSpacing

boolean

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

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

toJSON()

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

toJSON(): Word.Interfaces.ContentControlData;

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

track()

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

track(): Word.ContentControl;

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

untrack()

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

untrack(): Word.ContentControl;

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

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

onDataChanged

Примечание

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

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

[API set: WordApi BETA (PREVIEW ONLY)]

readonly onDataChanged: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;

Тип события

onDeleted

Примечание

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

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

[API set: WordApi BETA (PREVIEW ONLY)]

readonly onDeleted: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;

Тип события

onSelectionChanged

Примечание

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

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

[API set: WordApi BETA (PREVIEW ONLY)]

readonly onSelectionChanged: OfficeExtension.EventHandlers<Word.ContentControlEventArgs>;

Тип события