|
<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > Docflow – документооборот Клиентские функции типа сущности Isolated |
|
|
<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > Docflow – документооборот Клиентские функции типа сущности Isolated |
|
Имя функции |
Модификатор |
Атрибут |
Описание |
virtual |
[Public] |
Добавить отметку о регистрации на заданную страницу документа |
|
virtual |
[Public] |
Добавить отметку о подписи к документу согласно символу-якорю |
|
virtual |
[Public] |
Проверить наличие текстового слоя |
|
virtual |
[Public] |
Проверить, поддерживается ли формат файла по его расширению |
|
virtual |
[Public] |
Сравнить сконвертированные в PDF тела |
|
virtual |
– |
Создать средство поиска штрих-кодов в документе |
|
virtual |
– |
Создать экземпляр класса сравнения документов |
|
virtual |
– |
Создать экземпляр класса парсера таблиц |
|
virtual |
– |
Создать конвертер в PDF/A |
|
virtual |
– |
Создать конвертер в PDF |
|
virtual |
– |
Создать экземпляр класса для простановки штампов |
|
virtual |
[Public] |
Заполнить метаданные pdf документа |
|
virtual |
[Public] |
Преобразовать документ в pdf |
|
virtual |
[Public] |
Преобразовать документ в pdf/a |
|
virtual |
[Public] |
Получить свойства поручений из тела документа |
|
virtual |
[Public] |
Получить координаты последнего вхождения строки в документ |
|
virtual |
[Public] |
Склеить файлы PDF в один |
|
virtual |
[Public] |
Поиск ИД документа по штрихкодам |
Добавить отметку о регистрации на заданную страницу документа.
Синтаксис
[Public]
public virtual Stream AddRegistrationStamp(Stream inputStream, string htmlStamp, int pageNumber, double rightIndentInCm, double bottomIndentInCm)
Параметры
inputStream – Поток с входным документом;
htmlStamp – Строка, содержащая html для отметки о регистрации;
pageNumber – Страница, на которой необходимо проставить отметку;
rightIndentInCm – Отступ с правого края, в см;
bottomIndentInCm – Отступ с нижнего края, в см.
Возвращаемое значение
Stream – Поток с документом.
Добавить отметку о подписи к документу согласно символу-якорю.
Если символов-якорей в документе нет, то отметка проставляется на последней странице.
Синтаксис
[Public]
public virtual Stream AddSignatureStamp(Stream inputStream, string extension, string htmlMark, string anchorSymbol, int searchablePagesNumber)
Параметры
inputStream – Поток с входным документом;
extension – Расширение файла;
htmlMark – Строка, содержащая html для отметки об ЭП;
anchorSymbol – Символ-якорь;
searchablePagesNumber – Количество страниц для поиска символа.
Возвращаемое значение
Stream – Поток с документом.
Проверить наличие текстового слоя.
Проверяется текстовый слой только на первой странице.
Синтаксис
[Public]
public virtual bool CheckDocumentTextLayer(Stream body)
Параметры
body – Тело документа.
Возвращаемое значение
bool – True, если документ содержит текстовый слой, иначе - False.
Проверить, поддерживается ли формат файла по его расширению.
Синтаксис
[Public]
public virtual bool CheckIfExtensionIsSupported(string extension)
Параметры
extension – Расширение файла.
Возвращаемое значение
bool – True/false.
Сравнить сконвертированные в PDF тела.
Синтаксис
[Public]
public virtual IDocumentComparisonResult ComparePdfVersions(Stream firstPdfStream, Stream secondPdfStream)
Параметры
firstPdfStream – Тело исходного документа;
secondPdfStream – Тело документа с изменениями.
Возвращаемое значение
IDocumentComparisonResult – Результат сравнения.
Создать средство поиска штрих-кодов в документе.
Синтаксис
public virtual Sungero.Docflow.Isolated.BarcodeParser.Parser CreateBarcodeParser()
Возвращаемое значение
Sungero.Docflow.Isolated.BarcodeParser.Parser – Средство поиска штрих-кодов в документе.
Создать экземпляр класса сравнения документов.
Синтаксис
public virtual DocumentComparer.Comparers.PdfComparer CreateDocumentComparer()
Возвращаемое значение
DocumentComparer.Comparers.PdfComparer – Экземпляр класса сравнения документов.
Создать экземпляр класса парсера таблиц.
Синтаксис
public virtual DocumentTableParser CreateDocumentTableParser(Stream stream)
Параметры
stream – Тело документа.
Возвращаемое значение
DocumentTableParser – Экземпляр класса парсера таблиц.
Создать конвертер в PDF/A.
Синтаксис
public virtual Sungero.Docflow.Isolated.PdfConverter.ConverterPdfA CreatePdfAConverter()
Возвращаемое значение
Sungero.Docflow.Isolated.PdfConverter.ConverterPdfA – Конвертер в PDF/A.
Создать конвертер в PDF.
Синтаксис
public virtual Sungero.Docflow.Isolated.PdfConverter.Converter CreatePdfConverter()
Возвращаемое значение
Sungero.Docflow.Isolated.PdfConverter.Converter – Конвертер в PDF.
Создать экземпляр класса для простановки штампов.
Синтаксис
public virtual Sungero.Docflow.Isolated.PdfConverter.PdfStamper CreatePdfStamper()
Возвращаемое значение
Sungero.Docflow.Isolated.PdfConverter.PdfStamper – Экземпляр PdfStamper.
Заполнить метаданные pdf документа.
Синтаксис
[Public]
public virtual Stream FillPdfDocumentMetadata(Stream inputStream, string author, DateTime creationDate, DateTime modificationDate)
Параметры
inputStream – Поток, содержащий данные исходного документа;
author – Автор документа;
creationDate – Дата создания документа;
modificationDate – Дата изменения документа.
Возвращаемое значение
Stream – Поток с документом.
Преобразовать документ в pdf.
Синтаксис
[Public]
public virtual Stream GeneratePdf(Stream inputStream, string extension)
Параметры
inputStream – Поток с входным документом;
extension – Расширение входного документа.
Возвращаемое значение
Stream – Поток с документом.
Преобразовать документ в pdf/a.
Синтаксис
[Public]
public virtual Stream GeneratePdfA(Stream inputStream, string extension, string pdfAVersion)
Параметры
inputStream – Поток содержащий данные исходного документа;
extension – Расширение исходного документа;
pdfAVersion – Версия pdf/a. Поддерживаемые значения: v1A, v1B.
Возвращаемое значение
Stream – Поток с документом.
Получить свойства поручений из тела документа.
Синтаксис
[Public]
public virtual List<Sungero.Docflow.Structures.Module.IMinutesActionItem> GetActionItemsProperties(Stream stream, List<string> tags)
Параметры
stream – Тело документа;
tags – Список тегов.
Возвращаемое значение
List<Sungero.Docflow.Structures.Module.IMinutesActionItem> – Структура содержащая свойства поручений.
Получить координаты последнего вхождения строки в документ.
Ось X - горизонтальная, ось Y - вертикальная. Начало координат - левый нижний угол.
Синтаксис
[Public]
public virtual IPdfStringSearchResult GetLastStringEntryPosition(System.IO.Stream pdfDocumentStream, int searchablePagesNumber, string searchString)
Параметры
pdfDocumentStream – Поток с входным документом в формате PDF;
searchablePagesNumber – Количество страниц для поиска строки;
searchString – Строка для поиска.
Возвращаемое значение
IPdfStringSearchResult – Структура с результатами поиска.
Склеить файлы PDF в один.
Синтаксис
[Public]
public virtual Stream MergePdf(Stream firstStream, Stream secondStream)
Параметры
firstStream – Первый PDF-файл;
secondStream – Второй PDF-файл, который добавляется к первому.
Возвращаемое значение
Stream – Склеенный файл, состоящий из первого и второго PDF-файлов.
Поиск ИД документа по штрихкодам.
Поиск штрихкодов осуществляется только на первой странице документа.
Формат штрихкода: Code128.
Синтаксис
[Public]
public virtual List<long> SearchDocumentBarcodeIds(System.IO.Stream document, string formattedTenantId)
Параметры
document – Документ;
formattedTenantId – Имя тенанта в формате, нужном при подстановке в штрих-код.
Возвращаемое значение
List<long> – Список распознанных ИД документа.
| © Компания Directum, 2024 |