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

Word.Interfaces.ContentControlData interface

  • Ссылка
Пакет:
word

Интерфейс, описывающий данные, возвращаемые путем вызова contentControl.toJSON().

Свойства

appearance

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

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

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

Возвращает данные элемента управления содержимым, если его тип — CheckBox. null В противном случае.
color

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

Возвращает данные элемента управления содержимым, если его тип — "ComboBox". null В противном случае.
contentControls

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

Возвращает данные элемента управления содержимым, если его тип — DropDownList. null В противном случае.
fields

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

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

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

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

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

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

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

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

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

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

Возвращает подтип элемента управления содержимым. Подтип может быть "RichTextInline", "RichTextParagraphs", "RichTextTableCell", "RichTextTableRow" и "RichTextTable" для элементов управления содержимым форматированного текста, "PlainTextInline" и "PlainTextParagraph" для элементов управления содержимым в виде обычного текста или "CheckBox" для элементов управления содержимым флажками.
tables

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

Указывает тег для идентификации элемента управления содержимым.
text

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

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

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

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

appearance

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

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

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

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

Комментарии

[ Набор API: WordApi 1.1 ]

cannotDelete

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

cannotDelete?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

cannotEdit

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

cannotEdit?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

checkboxContentControl

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

checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;

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

Word.Interfaces.CheckboxContentControlData

Комментарии

[ Набор API: WordApi 1.7 ]

color

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

color?: string;

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

string

Комментарии

[ Набор API: WordApi 1.1 ]

comboBoxContentControl

Возвращает данные элемента управления содержимым, если его тип — "ComboBox". null В противном случае.

comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData;

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

Word.Interfaces.ComboBoxContentControlData

Комментарии

[ Набор API: WordApi 1.9 ]

contentControls

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

contentControls?: Word.Interfaces.ContentControlData[];

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

Word.Interfaces.ContentControlData[]

Комментарии

[ Набор API: WordApi 1.1 ]

dropDownListContentControl

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

dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData;

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

Word.Interfaces.DropDownListContentControlData

Комментарии

[ Набор API: WordApi 1.9 ]

fields

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

fields?: Word.Interfaces.FieldData[];

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

Word.Interfaces.FieldData[]

Комментарии

[ Набор API: WordApi 1.4 ]

font

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

font?: Word.Interfaces.FontData;

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

Word.Interfaces.FontData

Комментарии

[ Набор API: WordApi 1.1 ]

id

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

id?: number;

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

number

Комментарии

[ Набор API: WordApi 1.1 ]

inlinePictures

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

inlinePictures?: Word.Interfaces.InlinePictureData[];

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

Word.Interfaces.InlinePictureData[]

Комментарии

[ Набор API: WordApi 1.1 ]

lists

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

lists?: Word.Interfaces.ListData[];

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

Word.Interfaces.ListData[]

Комментарии

[ Набор API: WordApi 1.3 ]

paragraphs

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

paragraphs?: Word.Interfaces.ParagraphData[];

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

Word.Interfaces.ParagraphData[]

Комментарии

[ Набор API: WordApi 1.1 ]

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

placeholderText

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

placeholderText?: string;

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

string

Комментарии

[ Набор API: WordApi 1.1 ]

removeWhenEdited

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

removeWhenEdited?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

style

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

style?: string;

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

string

Комментарии

[ Набор API: WordApi 1.1 ]

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

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

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"

Комментарии

[ Набор API: WordApi 1.3 ]

subtype

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

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"

Комментарии

[ Набор API: WordApi 1.3 ]

tables

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

tables?: Word.Interfaces.TableData[];

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

Word.Interfaces.TableData[]

Комментарии

[ Набор API: WordApi 1.3 ]

tag

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

tag?: string;

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

string

Комментарии

[ Набор API: WordApi 1.1 ]

text

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

text?: string;

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

string

Комментарии

[ Набор API: WordApi 1.1 ]

title

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

title?: string;

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

string

Комментарии

[ Набор API: WordApi 1.1 ]

type

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

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"

Комментарии

[ Набор API: WordApi 1.1 ]