Type Alias PDFConfiguration

PDFConfiguration: ApprovalFormsInclusionConfiguration & {
    excludedCSSClasses?: string[];
    excludedElementIds?: string[];
    includeCalendarBookingInPdf?: boolean;
    includeExternalIdInPdf?: boolean;
    includePaymentInPdf?: boolean;
    includeSubmissionIdInPdf?: boolean;
    pdfFileName?: string;
    pdfSize?: FormSubmissionPDFPageSize;
    usePagesAsBreaks?: boolean;
}

Type declaration

  • OptionalexcludedCSSClasses?: string[]

    An array of class names to exclude from the submission when generating pdf.

  • OptionalexcludedElementIds?: string[]

    An array of element ids to exclude from the submission when generating pdf.

  • OptionalincludeCalendarBookingInPdf?: boolean

    Whether the calendar booking details associated with the submission should be included in the generated pdf (defaults to false)

  • OptionalincludeExternalIdInPdf?: boolean

    Whether the external id should be included in the generated pdf (defaults to false).

  • OptionalincludePaymentInPdf?: boolean

    Whether the payment details associated with the submission should be included in the generated pdf (defaults to false).

  • OptionalincludeSubmissionIdInPdf?: boolean

    Whether the submission id should be included in the generated pdf (defaults to false).

  • OptionalpdfFileName?: string

    The name of the PDF file sent to the configured email address.

  • OptionalpdfSize?: FormSubmissionPDFPageSize

    The page size of the Generated PDF.

  • OptionalusePagesAsBreaks?: boolean

    Whether pages in the form submission should translate to page breaks in the PDF.

Settings

Member Visibility