Группа «Преобразование документов»
Contents
Группа содержит прикладной блок «Преобразование документа в PDF».
Имя блока – ConvertEDocumentToPDF.
Назначение: для преобразования отдельного документа или коллекции документов в формат PDF с помощью сервиса преобразования в PDF. Подробнее см. пример использования блока.
Прикладной блок наследует свойства базового блока «Сценарий» и имеет дополнительные свойства:
Имя |
Заголовок |
Тип |
Описание |
EDocuments |
Документы |
Электронный документ или Коллекция документов (Константа или параметр) |
Документ или несколько документов, которые должны быть преобразованы в PDF |
EDocVersionState |
Состояние версии |
Признак (константа) |
Состояние версии, которая должна быть преобразована в PDF. Если не указано, то преобразуется последняя версия документа. Возможные значения: В разработке, Действующая, Устаревшая |
ToNewVersion |
В новую версию |
Логический (константа) |
Признак того, что преобразованный документ необходимо поместить в новую версию документа |
NewComment |
Текст примечания |
Строка |
Новое примечание для версии, в которую помещается преобразованный документ |
TransformationName |
Имя способа преобразования в PDF |
Строка |
Имя способа преобразования в PDF соответствует имени записи справочника Настройки преобразования в PDF. Если свойство не задано, применяются настройки, используемые в справочнике по умолчанию |
Результаты выполнения: в результате выполнения блока возвращается одно из значений:
Код |
Наименование |
Примечание |
C |
Конвертация выполнена |
Конвертация документов выполнена успешно |
N |
Конвертация не выполнена |
Конвертация документов не выполнена |
Описание:
Прикладной блок преобразует версию документов, указанных в параметре типа Электронный документ или Коллекция документов, в формат PDF:
| • | в свойстве блока Состояние версии указывается состояние версии, которая должна преобразоваться в PDF. Если свойство не задано либо нет версии документа с указанным состоянием, то преобразуется последняя версия документа; |
| • | в свойстве блока В новую версию указывается помещать или нет преобразованный документ в новую версию; |
| • | в свойстве Текст примечания указывается новое примечание для версии, в которую попадет преобразованный документ; |
| • | в свойстве Имя способа преобразования в PDF указывается имя способа преобразования в PDF из справочника «Настройки преобразования в PDF». Если свойство не задано, применяются настройки, используемые в справочнике по умолчанию; |
| • | если в процессе преобразования возникнут ошибки, то результатом выполнения блока будет значение Конвертация не выполнена. Если преобразование будет выполнено успешно, то результатом будет Конвертация выполнена; |
| • | если в свойстве Документы указана Коллекция документов, то преобразуются все документы этой коллекции. Если в ходе преобразования одного из документов коллекции возникнут ошибки, то результатом выполнения блока будет значение Конвертация не выполнена. |
| © Компания Directum, 2020 | Сообщество пользователей Directum |