Nutrient Web SDK
    Preparing search index...

    Type Alias ExportPDFFlags

    Export options object *

    type ExportPDFFlags = {
        excludeAnnotations?: boolean;
        flatten?: boolean;
        flattenElectronicSignatures?: boolean;
        includeComments?: boolean;
        incremental?: boolean;
        officeConversionSettings?: OfficeConversionSettings;
        optimize?: boolean | OptimizationFlags;
        outputFormat?: boolean | PDFAFlags;
        permissions?: {
            documentPermissions: IDocumentPermissions[];
            ownerPassword: string;
            userPassword: string;
        };
        saveForPrinting?: boolean;
    }
    Index

    Properties

    excludeAnnotations?: boolean

    Whether the document annotations should be exported.

    false
    
    flatten?: boolean

    Whether the document annotations should be converted to PDF content and therefore not editable in the future.

    false
    
    flattenElectronicSignatures?: boolean
    includeComments?: boolean
    true
    
    incremental?: boolean

    Whether the document should be exported using "full" or "incremental" saving. Default: false, or true if the document is digitally signed and the license includes the Digital Signatures component.

    officeConversionSettings?: OfficeConversionSettings
    optimize?: boolean | OptimizationFlags

    If set to true the exported document will have a default set of options:

    {
    documentFormat: 'pdf',
    grayscaleText: false,
    grayscaleGraphics: false,
    grayscaleFormFields: false,
    grayscaleAnnotations: false,
    grayscaleImages: false,
    disableImages: false,
    mrcCompression: false,
    imageOptimizationQuality: 2,
    linearize: false,
    }

    Otherwise, you can pass the above options object customised with your own values instead of a boolean value.

    false
    
    outputFormat?: boolean | PDFAFlags

    If set to true, a default set of options will be applied to the exported document:

    {
    conformance: NutrientViewer.Conformance.PDFA_2B,
    vectorization: true,
    rasterization: true,
    }

    Instead of a boolean value you can pass your own object ith custom values for the properties above.

    false
    
    permissions?: {
        documentPermissions: IDocumentPermissions[];
        ownerPassword: string;
        userPassword: string;
    }

    Contain the userPassword and ownerPassword to encrypt the PDF along with the documentPermissions.

    Type Declaration

    • documentPermissions: IDocumentPermissions[]

      An Array that specifies what users can do with the output PDF.

    • ownerPassword: string

      The owner password to encrypt the PDF.

    • userPassword: string

      The user password to encrypt the PDF.

    saveForPrinting?: boolean
    false