Word.Interfaces.ContentControlCollectionLoadOptions interface

Пакет:

word

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

Комментарии

[ Набор 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	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает замещающий текст элемента управления содержимым. Если элемент управления содержимым пуст, отображается затемненный текст. Примечание. Операция задания для этого свойства не поддерживается в Word в Интернете.
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;

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

Word.Interfaces.CheckboxContentControlLoadOptions

Комментарии

[ Набор API: WordApi 1.7 ]

color

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: задает цвет элемента управления содержимым. Цвет указывается в формате "#RRGGBB" или с помощью имени цвета.

color?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

font

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: получает текстовый формат элемента управления содержимым. Используйте это свойство, чтобы получать и задавать имея, размер, цвет и другие свойства шрифта.

font?: Word.Interfaces.FontLoadOptions;

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

Word.Interfaces.FontLoadOptions

Комментарии

[ Набор API: WordApi 1.1 ]

id

Для КАЖДОГО ЭЛЕМЕНТА в коллекции получает целое число, представляющее идентификатор элемента управления содержимым.

id?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.1 ]

parentBody

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает родительский текст элемента управления содержимым.

parentBody?: Word.Interfaces.BodyLoadOptions;

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

Word.Interfaces.BodyLoadOptions

Комментарии

[ Набор API: WordApi 1.3 ]

parentContentControl

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает элемент управления содержимым, содержащий элемент управления содержимым. Выдает ошибку ItemNotFound , если родительского элемента управления содержимым нет.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

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

Word.Interfaces.ContentControlLoadOptions

Комментарии

[ Набор API: WordApi 1.1 ]

parentContentControlOrNullObject

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает элемент управления содержимым, содержащий элемент управления содержимым. Если родительского элемента управления содержимым нет, этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

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

Word.Interfaces.ContentControlLoadOptions

Комментарии

[ Набор API: WordApi 1.3 ]

parentTable

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает таблицу, содержащую элемент управления содержимым. Выдает ошибку ItemNotFound , если она не содержится в таблице.

parentTable?: Word.Interfaces.TableLoadOptions;

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

Word.Interfaces.TableLoadOptions

Комментарии

[ Набор API: WordApi 1.3 ]

parentTableCell

Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает ячейку таблицы, содержащую элемент управления содержимым. Выдает ошибку ItemNotFound , если она не содержится в ячейке таблицы.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

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

Word.Interfaces.TableCellLoadOptions

Комментарии

[ Набор API: WordApi 1.3 ]

parentTableCellOrNullObject

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

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

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

Word.Interfaces.TableCellLoadOptions

Комментарии

[ Набор API: WordApi 1.3 ]

parentTableOrNullObject

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает таблицу, содержащую элемент управления содержимым. Если он не содержится в таблице, то этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

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

Word.Interfaces.TableLoadOptions

Комментарии

[ Набор API: WordApi 1.3 ]

placeholderText

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает замещающий текст элемента управления содержимым. Если элемент управления содержимым пуст, отображается затемненный текст.

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

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 ]