Russian (Русский) - Change language
IDocument
Назначение
Служит для представления документа.
Замечание. Для некоторых методов и свойств объекта не поддерживается локальная проверка правил на Веб-станции Верификации. Не поддерживаемые методы и свойства отмечены звездочкой (*).
Методы
| Определение | Описание |
| AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool ) * |
Добавляет пользовательский файл с заданным именем в результаты экспорта документа. Если в настройках проекта задан корневой путь экспорта, то в результаты экспорта документа добавляется пользовательский файл, адрес которого задается в параметре sourceFile. Адрес экспорта указывается в параметре destinationName. Если файл с заданным именем уже существует, а параметр replaceIfExists имеет значение true, то этот файл будет заменен. Если файл с заданным именем уже существует, а параметр replaceIfExists имеет значение false, то при попытке заменить существующий файл в логе появится сообщение об ошибке.
|
| CheckRules( ) * | Проверяет все правила в документе. Требуются права на запись в документ. |
| Field( name : string ) : IField * | Доступ к полю документа по полному пути к нему. Используются полные пути. Является внутренним** полем. Использование в правилах запрещено. |
| HasField( name : string ) : bool * | Есть поле с указанным путём. Используются относительные пути. Является внутренним** полем. Использование в правилах запрещено. |
| IndexedItemValue( name : string ) : VARIANT * | Позволяет получить значение поля по пути к нему или по имени. Доступно из внешних полей документов и страниц. Разрешается использовать имя поля или полный путь к полю в документе. Использование в правилах запрещено. |
| IndexedItemValues( name : string ) : IVARIANTArray * | Позволяет получить множество индексных полей, соответствующих одному полю в определении документа. Если поле помечено как индексное в повторяющемся разделе, метод возвращает все значения этого поля для всех разделов. Доступно из внешних полей документов и страниц. Разрешается использовать имя поля или полный путь к полю в документе. Использование в правилах запрещено. |
| Property( name : string ) : VARIANT |
Возвращает значение предопределённого свойства по его имени. Возвращаемое значение может быть в виде строки, числа или времени. Имена свойств и возвращаемые значения:
|
| SaveAs( filename : string, [optional] options : IExportImageSavingOptions ) * | Сохраняет изображение одностраничного или многостраничного документа. Если в опциях формат сохранения не указан, изображение сохраняется в формате TIF. Является внутренним** полем. |
| SaveAsStream( [optional] options: IExportImageSavingOptions ) : byte[] * |
Сохраняет документ в поток в памяти и возвращает его как массив byte (COM SafeArray).
|
| SaveXmlToFile( filename : string ) * | Сохраняет XML-файл с описанием документа по указанному пути для использования на веб-станции верификации. |
| SaveXmlToFileStorage() * | Сохраняет XML-файл с описанием документа в файловое хранилище для использования на веб-станции верификации. |
Внимание! Метод Property не следует путать с коллекцией Properties, которая содержит свойства документа, задаваемые пользователем.
Свойства
| Имя | Тип | Права | Значение |
| Action * | IActionResult | Только чтение | Использование этого свойства имеет смысл только в скриптах экспорта и пост-экспорта. |
| AsBatchItem * | IBatchItem | Только чтение | Преобразовывает в элемент типа IBatchItem. |
| AssemblingErrors | IAssemblingErrors | Только чтение | Коллекция ошибок сборки. Доступ к коллекции всегда только на чтение. |
| Attachments | IUserAttachments | Только чтение | Пользовательские файлы вложений. |
| Batch | IBatch | Только чтение | Пакет. Независимо от прав скрипта на документ, доступ к пакету будет только на чтение, внутренние** поля документов и страниц недоступны. |
| BatchName | string | Только чтение | Имя пакета. |
| Children * | IFields | Только чтение | Дочерние поля документа – разделы. В отличие от свойства Sections, порядок разделов соответствует их порядку в определении документа. Повторяющиеся разделы представлены одним элементом и сами повторения доступны через метод Items такого элемента. Является внутренним** полем. Использование в правилах запрещено. |
| Comment | string | Чтение/запись | Комментарий документа. |
| DefinitionName | string | Только чтение | Имя определения документа. |
| DocumentDefinition | IDocumentDefinitionInfo | Только чтение | Детальная информация о наложенном на документ определении документа. Для нераспознанных и необработанных документов свойство возвращает пустую строку. |
| HasErrors | bool | Только чтение | Есть ли в документе однополевые или многополевые ошибки. |
| HasUnpreparedImages | bool | Только чтение | Содержит ли документ непредобработанные страницы. |
| HasWarnings | bool | Только чтение | Есть ли в документе предупреждения правил или формата. |
| Id | string | Только чтение | Идентификатор документа (External Id). Значение начинается с 1 и уникально только в пределах пакета. |
| Index | int | Только чтение | Индекс документа в пакете. Значение начинается с 0 и уникально только в пределах задачи. |
| IsAnalyzed | bool | Только чтение | Проанализирован ли документ. Документ считается проанализрованным, если проанализирована каждая страница документа. |
| IsAssembled | bool | Только чтение | Собран ли документ. |
| IsExcludedFromAutomaticAssembling | bool | Чтение/запись | Участвует ли документ в автоматической сборке. |
| IsExported | bool | Только чтение | Проэкспортирован ли документ. |
| IsRecognized | bool | Только чтение | Распознан ли документ. Документ считается распознанным, если каждая страница документа либо распознана, либо является страницей-приложением. |
| IsUsedForTraining | bool | Чтение/запись | Используется ли документ в обучении. |
| IsVerified | bool | Только чтение | Верифицирован ли документ. |
| Pages | IPages | Только чтение | Страницы документа. |
| PreviousStageInfo * | IStageInfo | Только чтение | Возвращает объект IStageInfo - информацию о предыдущем этапе обработки документа. Поля TaskId, PrincipalId не используются. |
| Priority | TProcessingPriority | Только чтение | Приоритет документа. |
| ProcessingErrors * | string | Только чтение | Ошибки процесса обработки, разделённые через перенос строки. |
| ProcessingWarnings * | string | Только чтение | Предупреждения процесса обработки, разделённые через перенос строки. |
| ProhibitedUserId * | int | Только чтение | Задание, созданное из документа, не будет доступно пользователю с данным идентификатором. По умолчанию имеет значение "0" - означает, что задание доступно любому пользователю. |
| Properties | IProperties | Только чтение | Регистрационные параметры документа. |
| RecognizedSymbolsCount * | int | Только чтение | Число распознанных символов. |
| RuleErrors * | IRuleErrors | Только чтение |
Коллекция ошибок в документе (ошибки формата, ошибки правил, ошибки при слиянии результатов двойной верификации).
|
| Sections * | IFields | Только чтение | Плоский список разделов документа. Если раздел повторяется, то в списке лежат все повторения раздела. Порядок разделов в списке соответствует порядку первых страниц разделов в документе. Разделы без страниц идут последними в списке. Является внутренним** полем. Использование в правилах запрещено. |
| StageInfo | IStageInfo | Только чтение | Информация об этапе обработки документа на Сервере Приложений. |
| SymbolsForVerificationCount | int | Только чтение | Число символов, для которых требуется верификация. |
| TotalSymbolsCount | int | Только чтение | Общее число символов. |
| UncertainSymbolsCount | int | Только чтение | Число неуверенно распознанных символов. |
1/14/2021 2:17:24 PM