PdfOptions

data class PdfOptions(val version: PdfVersion? = null, val encryptFile: Boolean? = null, val documentOpenPassword: String? = null, val permissionPassword: String? = null, val restrictPermissions: Boolean? = null, val printing: PdfPrinting? = null, val changes: PdfChanges? = null, val watermark: String? = null, val watermarks: List<Watermark> = emptyList(), val pdfUaCompliance: Boolean? = null, val useTaggedPdf: Boolean? = null, val pageRange: String? = null, val useLosslessCompression: Boolean? = null, val reduceImageResolution: Boolean? = null, val maxImageResolution: ImageResolution? = null, val exportFormFields: Boolean? = null, val exportNotes: Boolean? = null)

PDF formatOptions. null leaves the Carbone default.

Constructors

Link copied to clipboard
constructor(version: PdfVersion? = null, encryptFile: Boolean? = null, documentOpenPassword: String? = null, permissionPassword: String? = null, restrictPermissions: Boolean? = null, printing: PdfPrinting? = null, changes: PdfChanges? = null, watermark: String? = null, watermarks: List<Watermark> = emptyList(), pdfUaCompliance: Boolean? = null, useTaggedPdf: Boolean? = null, pageRange: String? = null, useLosslessCompression: Boolean? = null, reduceImageResolution: Boolean? = null, maxImageResolution: ImageResolution? = null, exportFormFields: Boolean? = null, exportNotes: Boolean? = null)

Types

Link copied to clipboard
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Changes permission level.

Link copied to clipboard

DocumentOpenPassword, required to open the document.

Link copied to clipboard

EncryptFile; requires documentOpenPassword and/or permissionPassword.

Link copied to clipboard

ExportFormFields.

Link copied to clipboard

ExportNotes.

Link copied to clipboard

MaxImageResolution, in DPI.

Link copied to clipboard

e.g. "1-3".

Link copied to clipboard

PDFUACompliance.

Link copied to clipboard

PermissionPassword, required to lift the restrictions set by restrictPermissions.

Link copied to clipboard

Printing permission level.

Link copied to clipboard

ReduceImageResolution, used together with maxImageResolution.

Link copied to clipboard

RestrictPermissions: apply printing / changes restrictions to the document.

Link copied to clipboard

UseLosslessCompression.

Link copied to clipboard

UseTaggedPDF.

Link copied to clipboard

SelectPdfVersion; null leaves the server default (PDF 1.6).

Link copied to clipboard

Legacy single centered watermark. Prefer watermarks.

Link copied to clipboard

Watermarks, at most MAX_WATERMARKS entries.