Word.Interfaces.FieldCollectionLoadOptions interface

Пакет:

word

Содержит коллекцию Word. Объекты полей.

Комментарии

[ Набор API: WordApi 1.4 ]

Важно! Дополнительные сведения о том, какие поля можно вставить, см. в разделе, представленном Word.Range.insertField API в наборе требований 1.5. Поддержка управления полями аналогична поддержке, доступной в пользовательском интерфейсе Word. Однако, хотя пользовательский интерфейс Word в Интернете в основном поддерживает поля только для чтения (см. раздел Коды полей в Word для Интернета), Addin поле можно редактировать. Дополнительные сведения о клиентах пользовательского интерфейса Word, которые более полно поддерживают поля, см. в списке продуктов в начале раздела Вставка, изменение и просмотр полей в Word.

Свойства

$all	Указание $all для параметров загрузки загружает все скалярные свойства (например,Range.address ), но не свойства навигации (например, Range.format.fill.color).
code	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает инструкцию кода поля.
data	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает данные в поле Addin. Если поле не является полем Addin, оно является null и будет вызывать общее исключение при попытке кода задать его.
kind	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает тип поля.
locked	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает, заблокировано ли поле. true Значение , если поле заблокировано, в false противном случае — значение .
parentBody	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает родительский текст поля.
parentContentControl	Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает элемент управления содержимым, содержащий поле. Выдает ошибку ItemNotFound , если родительского элемента управления содержимым нет.
parentContentControlOrNullObject	Для КАЖДОГО ЭЛЕМЕНТА в коллекции. Возвращает элемент управления содержимым, содержащий поле. Если родительского элемента управления содержимым нет, этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTable	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает таблицу, содержащую поле . Выдает ошибку ItemNotFound , если она не содержится в таблице.
parentTableCell	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает ячейку таблицы, содержащую поле . Выдает ошибку ItemNotFound , если она не содержится в ячейке таблицы.
parentTableCellOrNullObject	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает ячейку таблицы, содержащую поле . Если он не содержится в ячейке таблицы, этот метод вернет объект со свойством , для него isNullObject задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
parentTableOrNullObject	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает таблицу, содержащую поле . Если он не содержится в таблице, то этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
result	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает результирующих данных поля.
type	Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает тип поля.

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

$all

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

$all?: boolean;

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

boolean

code

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

code?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.4 ]

Примечание. Возможность задания кода появилась в WordApi 1.5.

data

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

data?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.5 ]

kind

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает тип поля.

kind?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.5 ]

locked

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: указывает, заблокировано ли поле. true Значение , если поле заблокировано, в false противном случае — значение .

locked?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.5 ]

parentBody

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

parentBody?: Word.Interfaces.BodyLoadOptions;

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

Word.Interfaces.BodyLoadOptions

Комментарии

[ Набор API: WordApi 1.4 ]

parentContentControl

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

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

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

Word.Interfaces.ContentControlLoadOptions

Комментарии

[ Набор API: WordApi 1.4 ]

parentContentControlOrNullObject

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

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

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

Word.Interfaces.ContentControlLoadOptions

Комментарии

[ Набор API: WordApi 1.4 ]

parentTable

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

parentTable?: Word.Interfaces.TableLoadOptions;

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

Word.Interfaces.TableLoadOptions

Комментарии

[ Набор API: WordApi 1.4 ]

parentTableCell

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

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

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

Word.Interfaces.TableCellLoadOptions

Комментарии

[ Набор API: WordApi 1.4 ]

parentTableCellOrNullObject

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

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

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

Word.Interfaces.TableCellLoadOptions

Комментарии

[ Набор API: WordApi 1.4 ]

parentTableOrNullObject

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

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

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

Word.Interfaces.TableLoadOptions

Комментарии

[ Набор API: WordApi 1.4 ]

result

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

result?: Word.Interfaces.RangeLoadOptions;

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

Word.Interfaces.RangeLoadOptions

Комментарии

[ Набор API: WordApi 1.4 ]

type

Для КАЖДОГО ЭЛЕМЕНТА в коллекции: возвращает тип поля.

type?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.5 ]