Word.Interfaces.FieldLoadOptions interface

Пакет:

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	Возвращает результирующих данных поля.
showCodes	Указывает, отображаются ли коды полей для указанного поля. true Значение , если коды полей отображаются, в false противном случае — значение .
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 ]

showCodes

Указывает, отображаются ли коды полей для указанного поля. true Значение , если коды полей отображаются, в false противном случае — значение .

showCodes?: boolean;

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

boolean

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

type

Возвращает тип поля.

type?: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.5 ]