Bluestep JS Documentation
    Preparing search index...

    Class PDFField

    Represents a field inside a PDF Document.

    Index

    Constructors

    Methods

    • Returns the alternateFieldName for the field.

      Returns string

    • Set the alternateFieldName for the field.

      Parameters

      • value: string

      Returns void

    • Returns the flags for the field.

      Returns number

    • Set the flags for the field.

      Parameters

      • value: number

      Returns void

    • Returns the isNoExport value for the field.

      Returns boolean

    • Returns the mappingName for the field.

      Returns string

    • Set the mappingName for the field.

      Parameters

      • value: string

      Returns void

    • Returns the name for the field.

      Returns string

    • Set the noExport for the field.

      Parameters

      • value: boolean

      Returns void

    • Returns the partialName value for the field.

      Returns string

    • An object containing the possible values which may be assigned to this field. The indexes of the array are Strings indicating the display value of the matching internal value. If this array contains any entries, the value field will be contrained to hold only null or one of these values. Although, technically, it is possible to have multiple, identical display values with different actual values, this situation is not supported at this time. However, it is not as uncommon to have multiple display values translate to the same actual value, and this situation is supported.

      Returns { [key: string]: string }

    • Returns the readOnly value for the field.

      Returns boolean

    • Set the readOnly for the field.

      Parameters

      • value: boolean

      Returns void

    • Returns the required value for the field.

      Returns boolean

    • Set the required for the field.

      Parameters

      • value: boolean

      Returns void

    • Returns the fields type

      Returns string

    • A string value containing the value in the field.

      Returns string

    • Set the value for the field.

      Parameters

      • value: string

      Returns void