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


Word.Interfaces.ContentControlLoadOptions interface

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

Комментарии

[ Набор API: WordApi 1.1 ]

Свойства

$all

Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).

appearance

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

cannotDelete

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

cannotEdit

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

checkboxContentControl

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

color

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

font

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

id

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

parentBody

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

parentContentControl

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

parentContentControlOrNullObject

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

parentTable

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

parentTableCell

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

parentTableCellOrNullObject

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

parentTableOrNullObject

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

placeholderText

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

removeWhenEdited

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

style

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

styleBuiltIn

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

subtype

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

tag

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

text

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

title

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

type

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

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

$all

Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).

$all?: boolean;

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

boolean

appearance

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

appearance?: boolean;

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

boolean

Комментарии

[ Набор 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.CheckboxContentControlLoadOptions;

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

Комментарии

[ Набор API: WordApi 1.7 ]

color

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

color?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

font

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

font?: Word.Interfaces.FontLoadOptions;

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

Комментарии

[ Набор API: WordApi 1.1 ]

id

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

id?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

parentBody

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

parentBody?: Word.Interfaces.BodyLoadOptions;

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

Комментарии

[ Набор API: WordApi 1.3 ]

parentContentControl

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

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

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

Комментарии

[ Набор API: WordApi 1.1 ]

parentContentControlOrNullObject

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

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

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

Комментарии

[ Набор API: WordApi 1.3 ]

parentTable

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

parentTable?: Word.Interfaces.TableLoadOptions;

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

Комментарии

[ Набор API: WordApi 1.3 ]

parentTableCell

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

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

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

Комментарии

[ Набор API: WordApi 1.3 ]

parentTableCellOrNullObject

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

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

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

Комментарии

[ Набор API: WordApi 1.3 ]

parentTableOrNullObject

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

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

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

Комментарии

[ Набор API: WordApi 1.3 ]

placeholderText

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

placeholderText?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

removeWhenEdited

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

removeWhenEdited?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

style

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

style?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

styleBuiltIn

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

styleBuiltIn?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.3 ]

subtype

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

subtype?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.3 ]

tag

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

tag?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

text

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

text?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

title

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

title?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

type

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

type?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]