Bluestep JS Documentation
    Preparing search index...

    Class PDFDocument

    PDF Converter

    ```javascript

    const pdfDocUrl = B.toBinaryFileUrl(
      'myfile.pdf', 
      (fName, out) => B.pdf(inputStream, '.txt').transferTo(out)), 
      'application/pdf');
    Index

    Constructors

    constructor

    Methods

    append fields fieldsAsMap flatten transferTo

    Constructors

    Methods

    • Appends the modified PDF to a temporary file. The function receives an optional [[Bluestep.Net.FetchedResource]] of the new PDF. If no [[Bluestep.Net.FetchedResource]] is given, then the orginal [[Bluestep.Net.FetchedResource]] is used.

      Parameters

      Returns void

    • Appends the modified PDF to a temporary file.

      Parameters

      • input: InputStream

        InputStream to read the file.

      • OptionalfileNameSuffix: string

        File suffix of the [[Java.IO.InputStream]]. Used to help in conversion to pdf. If not provided then the [[Java.IO.InputStream]] is assumed to be a pdf.

      Returns void

    • An object of [[PDFField]] within the PDF document. This object is has keys that are the names of the fields and the values are [[PDFField]]s.

      Returns { [key: string]: PDFField }

    • Same as [[fields]] but organized as a Map

      Returns Map<String, PDFField>

    • A boolean value indicating whether the form fields should be 'flattened' when the PDF is saved. All form fields will be eliminated and the field values will be written into the PDF as text. This gives the visual appearance when displayed or printed that the form has been filled out, but the fields can no longer be easily accessed and changed programatically. Also, a flattened form cannot be modified by re-filling it out with the PDF viewer. It is a method of locking the form results.

      Parameters

      • newValue: boolean

      Returns boolean

    • Returns the flatten value.

      Returns boolean

    • Transfer the pdf to the provided OutputStream. Returns true if there is a valid pdfDocument to write

      Parameters

      Returns true

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods