ДокументPdf
Стд::Pdf::ДокументPdf Доступность: Сервер
Объект для работы с документом формата PDF.
Сравнение ссылочное
Иерархия типа
Базовые типы: Закрываемое, Объект
Конструкторы
ДокументPdf
Доступность: Сервер
ДокументPdf()ДокументPdf, в котором создаётся пустой документ в формате PDF.
Методы
ДобавитьСтраницу
Доступность: Сервер
ДобавитьСтраницу(
Индекс: Число,
Размер: РазмерСтраницы
): СтраницаPdfРазмер в PDF документ под индексом Индекс.
Все страницы документа, имеющие индекс больше или равный Индекс, будут располагаться после добавляемой.
По умолчанию, страница добавляется в конец документа. Если документ пустой, то размер страницы по умолчанию - A4. Если страница вставляется в начало непустого документа, то берутся размеры страницы под нулевым индексом. Если существует предыдущая страница, то для создания используется её размер.
Метод возвращает объект типа СтраницаPdf, ссылающийся на добавленную страницу.
Исключения
ИсключениеИндексВнеГраниц - если индекс не лежит в границах: 0 ... ЧислоСтраниц.
ИсключениеНедопустимоеСостояние - если документ закрыт.
Примеры
Документ.ДобавитьСтраницу()
пер Страница = Документ.ДобавитьСтраницу(1)
Документ.ДобавитьСтраницу(2, новый РазмерСтраницы(200, 400))
Документ.ДобавитьСтраницу(2, РазмерСтраницы.A5())
ДобавитьСтраницуИзИзображения
Доступность: Сервер
ДобавитьСтраницуИзИзображения(
Поток: ПотокЧтения,
Индекс: Число,
Размер: РазмерСтраницы
): СтраницаPdfИндекс на основе изображения из потока.
Поддерживаемые форматы изображения: JPEG, TIFF, GIF, BMP, PNG.
Страница будет иметь указанные в миллиметрах размеры.
Все страницы документа, имеющие индекс больше или равный Индекс, будут располагаться после добавляемой.
По умолчанию, страница добавляется в конец документа. Если документ пустой, то размер страницы по умолчанию - A4. Если страница вставляется в начало непустого документа, то берутся размеры страницы под нулевым индексом. Если существует предыдущая страница, то для создания используется её размер.
Левый верхний угол изображения будет размещен в (x = 0, y = 0).
Размеры картинки, как максимально возможные, определяются автоматически, но так, чтобы она целиком уместилась
на странице, при этом сохраняется отношение сторон.
Метод возвращает объект типа СтраницаPdf, ссылающийся на добавленную страницу.
Исключения
ИсключениеИндексВнеГраниц - если индекс не лежит в границах: 0 ... ЧислоСтраниц.
ИсключениеВводаВывода - если чтение изображения завершилось неудачей.
ИсключениеPdf - ошибка при вставке изображения на страницу документа.
ИсключениеНедопустимоеСостояние - если документ закрыт.
Примеры
Документ.ДобавитьСтраницуИзИзображения(Поток)
пер Страница = Документ.ДобавитьСтраницуИзИзображения(Поток, 1)
Документ.ДобавитьСтраницуИзИзображения(Поток, 2, новый РазмерСтраницы(200, 400))
Документ.ДобавитьСтраницуИзИзображения(Поток, 2, РазмерСтраницы.A5())
Закрыть
Доступность: Сервер
Закрыть()Закрыть документ. Повторный вызов ничего не делает.
Примеры
пер Документ = новый ДокументPdf()
Документ.Закрыть()
Записать
Доступность: Сервер
Записать(
Поток: ПотокЗаписи,
Формат: ФорматДокументаPdf = ФорматДокументаPdf.Pdf,
Пароль: Строка = "")Поток типа ПотокЗаписи. Аргумент Формат позволяет указать формат для сохранения (обычный,
для долгосрочного хранения).
Если требуется защитить итоговый документ паролем, то его нужно передать в строковом представлении.
Если документ записывается в одном из форматов для долгосрочного хранения (ФорматДокументаPdf.PdfA1/2/3),
то он не будет защищён паролем, указанным в аргументе Пароль.
Исключения
ИсключениеВводаВывода - если запись документа завершилось неудачей,
или производится запись с паролем в одном из форматов: PdfA1, PdfA2, PdfA3.
ИсключениеНедопустимоеСостояние - если документ закрыт.
Примеры
Документ.Записать(Поток, ФорматДокументаPdf.Pdf, "") // Запись документа в формате pdf
Документ.Записать(Поток, ФорматДокументаPdf.Pdf, "12345") // Запись документа в формате pdf с паролем
Документ.Записать(Поток, ФорматДокументаPdf.PdfA1, "") // Запись документа в формате pdf/a-1a
Документ.Записать(Поток) // Запись до кумента в формате PDF без пароля
Документ.Записать(Поток, ФорматДокументаPdf.PDF) // Запись документа в формате pdf без пароля
ИмпортироватьИзDocx
Доступность: Сервер
Статический
ИмпортироватьИзDocx(
Поток: ПотокЧтения,
Пароль: Строка = ""
): Докум ентPdfПоток типа ПотокЧтения.
Если документ в формате DOCX защищён паролем, то его нужно указать в строковом представлении.
Пароль от документа не сохраняется.
Импорт документа из формата DOCX может занимать продолжительное время, а вид итогового PDF-документа может отличаться от первоначального.
Метод возвращает объект типа ДокументPdf.
Исключения
ИсключениеВводаВывода - если чтение документа завершилась неудачей. ИсключениеPdf - если конвертация документа завершилась неудачей.
Примеры
исп Документ1 = ДокументPdf.ИмпортироватьИзDocx(Поток) // Импорт документа без пароля
исп Документ2 = ДокументPdf.ИмпортироватьИзDocx(Поток, "") // Также импорт без пароля
исп Документ3 = ДокументPdf.ИмпортироватьИзDocx(Поток, "template123") // Импорт защищённого документа
ПолучитьКоличествоСтраниц
Доступность: Сервер
ПолучитьКоличествоСтраниц(): ЧислоИсключения
ИсключениеНедопустимоеСостояние - если документ закрыт.
Примеры
пер Число = Документ.ПолучитьКоличествоСтраниц()
ПолучитьСтраницу
Доступность: Сервер
ПолучитьСтраницу(Индекс: Число): СтраницаPdfИндекс в документе.
Исключения
ИсключениеИндексВнеГраниц - если страница с данным индексом отсутствует в документе. ИсключениеНедопустимоеСостояние - если документ закрыт.
Примеры
пер Страница = Документ.ПолучитьСтраницу(0)
Прочитать
Доступность: Сервер
Статический
Прочитать(
Поток: ПотокЧтения,
Пароль: Строка = ""
): ДокументPdfПоток типа ПотокЧтения.
Если документ в формате PDF защищён паролем, то его нужно передать в строковом представлении.
Пароль от документа не сохраняется.
Метод возвращает объект типа ДокументPdf.
Исключения
ИсключениеВводаВывода - если чтение документа завершилось неудачей.
Примеры
исп Документ1 = ДокументPdf.Прочитать(Поток) // Чтение документа без пароля
исп Документ2 = ДокументPdf.Прочитать(Поток, "") // Также чтение без пароля
исп Документ3 = ДокументPdf.Прочитать(Поток, "template123") // Чтение защищённого документа
УдалитьСтраницу
Доступность: Сервер
УдалитьСтраницу(Индекс: Число)Индекс из документа.
Исключения
ИсключениеИндексВнеГраниц - если страница с данным индексом отсутствует в документе. ИсключениеНедопустимоеСостояние - если документ закрыт.
Примеры
Документ.УдалитьСтраницу(0)