Russian (Русский) - Change language

IField

Назначение

Поле документа. Тип поля можно установить из свойства Type. Для полей-таблиц доступны методы Rows и Cell.

Методы

Определение Описание
AddRegion( page : IPage, rect : string ) : IFieldRegion

Добавляет полю регион с заданными координатами, где rect - строковое представление прямоугольника вида [left,top,right,bottom]. Требуются права на запись к объекту IField.

Пример кода

Замечание. Метод недоступен для таблиц. Для удаления региона используется метод IFieldRegion.Delete().

Cell( columnName : string, rowNum : int ) : IField Позволяет получить ячейку таблицы по имени столбца и номеру строки. Метод доступен только для таблиц. В скриптах правил этот метод недоступен.
CheckRules( ) Проверяет правила для данного поля и всех дочерних полей. В правилах этот метод недоступен.
Field( Path : string) : IField Поиск дочернего поля относительно данного. Используются относительные пути. В правилах разрешено только использование синонимов имён полей в том виде, как они заданы в настройках правил.
GetLangs() : IVARAIANTArray

Возвращает список идентификаторов языков, присутствующих в поле.

Пример

HasField( parameter : string) : bool Проверяет, есть ли поле с указанным путём. Используются относительные пути. В правилах разрешено только использование синонимов имён полей в том виде, как они заданы в настройках правил.
Suggest( VARIANT newSuggest )

Позволяет добавить подсказку к полю.

Замечание. Можно добавить значение или строку. Добавленные значения записываются с 4-мя знаками после запятой. Например, при вызове метода field.Suggest( "12.90" ) подсказка будет добавлена в виде "12.90", а при вызове метода field.Suggest( 12.90 ) - в виде 12.9000.

Свойства

Имя Тип Права Значение
Caption string Только чтение Название поля, отображаемое на форме. Значение свойства может совпадать со значением Name.
Children IFields Только чтение Дочерние элементы поля (для строк таблицы - ячейки) В скриптах правил это свойство недоступно.
FullName string Только чтение Полное имя поля относительно документа. Уникально идентифицирует поле в документе. Может быть использовано для поиска полей в документе через метод Field. В скриптах правил возвращаемое значение совпадает с Name и не является уникальным.
HasRuleError bool Чтение/запись

Связано ли с данным полем ошибка или предупреждение правила.

Замечание. В скриптах правил данное свойство определяет, отображать ли данное поле в сообщении об ошибке.

Правило включает коллекцию полей, указанных в диалогом окне свойств правила. Если проверка данного правила завершится неуспешно, в редакторе документа будет отображаться сообщение об ошибке (указанное в IRuleContext.ErrorMessage) и ссылки на поля из коллекции. Указав значение свойства false, можно исключить поле из списка ссылок, связанных с ошибкой.

IsExportable bool Только чтение Предназначено ли поле для экспорта (в соответствии с настройками определения документа).
IsIndexed bool Только чтение Является ли поле индексируемым. Если да, то значение этого поля может быть доступно из внешних полей документов и страниц определения документа.
IsMatched bool Только чтение Наложено ли поле.
IsSuspicious bool Только чтение Уверенно ли распознано значение поля.
IsValid bool Только чтение Проверяет, что поле не содержит ошибки формата.
IsVerified bool Чтение/запись

Верифицировано ли поле.
Замечание. Свойство не работает для группы полей.
В правилах можно присваивать этому полю значение true даже при отсутствии прав на запись в поле. Для того чтобы сбросить выставленный флаг, требуются права на запись.

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

Замечание. Присваивание флагу значения false не обеспечивает попадания поля на этап Верификации данных - для этого нужно использовать свойство NeedVerification интерфейсов IField или ICharacterParams.

IsVisible bool Чтение/запись Должно ли поле отражаться в форме документа (в соответствии с настройками определения документа).
Items IFields Только чтение Повторения поля (для таблиц - строки таблицы).
Name string Только чтение Имя поля в определении документа.
NeedVerification bool Чтение/запись

Требуется ли верификация самому полю (не символам, из которых оно состоит).

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

Чтобы указать, требуется ли верификация для отдельных символов (не для всего поля), используйте свойство NeedVerification интерфейса ICharacterParams.

ReadOnly bool Только чтение Доступно ли поле только для чтения (в соответствии с настройками определения документа). В скриптах правил этот флаг означает, что правило имеет права на запись в данное поле.
ReadOnlyInForm bool Чтение/запись Доступно ли поле на форме только для чтения (в соответствии с настройками определения документа.
Regions ** IFieldRegions Только чтение Массив регионов поля. Перетекающие поля могут иметь несколько регионов.
Rows IFields Только чтение Множество строк таблицы. Свойство недоступно для полей, не являющихся таблицами.
Symbols ICharactersParams Только чтение Подробная информация о свойствах символов текста.
Text string Чтение/запись Текстовое представление значения поля.
Type TExportFieldType Только чтение Тип поля.
Value VARIANT Чтение/запись Значение поля в виде VARIANT. Свойство возвращает объект типа Int32, если в настройках числового поля указано, что оно целое, а значение поля по модулю не превышает 2147483647. Если значение поля превышает указанное значение, то возвращает объект типа double.

** - Свойство недоступно, если в свойствах лицензии отключена опция Расширенный экспорт в XML.

11/10/2020 12:08:08 PM


Please leave your feedback about this article