IPage
Назначение
Служит для представления страницы.
Замечание. Для некоторых методов и свойств объекта не поддерживается локальная проверка правил на Веб-станции Верификации. Не поддерживаемые методы и свойства отмечены звездочкой (*).
Методы
Определение | Описание |
ApplyImageEnhancementProfile( name: string ) * |
Применяет заданный профиль улучшения к изображению. Если в результате применения профиля появляются новые страницы, то они будут добавлены в документ после текущей страницы. Пример |
MarkAsAnnex() * | Позволяет пометить страницу как приложение, не требующее распознавания. |
ReplaceImage( newPicture : IPictureObject ) * |
Заменяет изображение страницы на новое. Новое изображение может быть загружено из файла с помощью метода FCTools.LoadImage, создано из имеющегося в памяти изображения (например, .NET System.Drawing.Image) с помощью метода FCTools.PictureFromHBitmap либо получено путем редактирования другого объекта IPictureObject. |
RevertToOriginalImage() * |
Позволяет вернуться к оригинальному изображению. Вызов метода допускается, только если свойство HasOriginalImage имеет значение true. Пример |
SaveAs( filename : string, [optional] options : IExportImageSavingOptions ) * |
Позволяет сохранить изображение страницы в соответствии с настройками. Если опции сохранения не заданы, изображение сохраняется в формате TIF. Является внутренним** полем. |
SaveSourceFile () * |
Сохраняет исходный файл, из которого было получено изображение страницы, в заданный файл. Вызов допускается, только если исходный файл был сохранен (это можно выяснить с помощью свойства SourceFileGUID). См. также Примеры скриптов для описания экспорта. |
SaveXmlTextToFile( filename : string ) * | Сохраняет XML-файл с полным текстом страницы по указанному пути. |
SaveXmlTextToFileStorage() * | Сохраняет XML-файл с полным текстом страницы в файловое хранилище в папке пакета. |
Свойства
Имя | Тип | Права | Значение |
AsBatchItem * | IBatchItem | Только чтение | Преобразовывает в элемент типа IBatchItem. |
Attachments * | IUserAttachments | Только чтение | Пользовательские файлы вложений. |
Comment * | string | Только чтение | Описание страницы. |
Document * | IDocument | Только чтение | Документ, содержащий страницу. |
ExcludedFromDocumentImage * | bool | Чтение/запись. Можно изменять даже в скриптах с правами только на чтение | Используется при экспорте изображения документа. Означает, что изображение данной страницы не нужно экспортировать при экспорте всего документа. Является внутренним** полем. |
FullText * | string | Только чтение | Распознанный текст на странице. |
FullTextCharRects * | IRects | Только чтение | Прямоугольники символов из FullText. |
HasOriginalImage * | bool | Только чтение | Наличие или отсутствие оригинального изображения. |
Id | string | Только чтение | Идентификатор страницы. |
ImageSource * | string | Только чтение | Источник изображения. Если изображение добавлено из файла, содержит путь к исходному файлу. Для отсканированных страниц - имя источника. Возвращает пустое значение для изображений, полученных через пользовательский импорт. |
ImageSourceFileSubPath * | string | Только чтение | Путь исходного изображения относительно корневого каталога HotFolder или папки, из которой изображения были импортированы. |
ImageSourcePageNumber * | int | Только чтение | Номер исходной страницы в файле. |
ImageSourceType * | string | Только чтение | Строка "File", "Scanner" или "Custom" в зависимости от типа источника. |
Index * | int | Только чтение | Индекс страницы в документе. |
IsAnalyzed * | bool | Только чтение | Проанализирована ли страница. |
IsResultClassConfident * | bool | Чтение/запись | Уверенно ли классифицирована страница. |
MatchedSection * | IMatchedSectionInfo | Только чтение | Детальная информация о разделе определения документа, наложенном на страницу. Если раздел отсутствует, возвращает null. |
Picture * | IPictureObject | Только чтение | Изображение страницы. Является внутренним** полем. |
Rect * | IRect | Только чтение | Прямоугольник страницы. Является внутренним** полем. |
ReferenceClassName * | string | Только чтение | Эталонный класс страницы. |
ResultClassName * | string | Чтение/запись | Имя класса, к которому отнесена страница |
SectionName * | string | Только чтение | Имя раздела документа. |
SourceFileGUID * | string | Только чтение | Идентификатор исходного файла страницы электронного документа. Возвращает пустую сроку, если исходный файл не был сохранен. |
SourceImageRotation * | int | Только чтение |
Угол (в градусах), на который было повернуто исходное изображение. Возможные значения: 0, 90, 180, 270. Для страниц, повернутых против часовой стрелки, возвращается значение поворота по часовой стрелке (например, если изображение было повернуто на 90˚ против часовой стрелки, будет возвращено 270). Свойство доступно, только если открыт документ, содержащий страницу. Является внутренним** полем. Возвращает угол поворота для изображений:
Не учитывает значение поворота для изображений:
|
4/13/2021 11:12:44 AM