Class FileUploader

The HybridForms FileUploader. Upload files within a form.

Hierarchy

Constructors

constructor

Properties

allowedFormats audioFeedback buttonLabel defaultValue deleteOnNotFullfilledCondition descriptionEnd descriptionStart disposed element enabled label labelEl maxFileSizeKb maxFileUploads maxImagePixel maxPDFPages minFileSizeKb minImagePixel multipleUpload onChanged options renameFileIfExists required tooltip visiting

Methods

deleteAllAttachments deleteFields deleteFile disable dispose enable get getAllValues getDefault getPostfixFieldId getWithId hide isRepeatingUnit openFileUploadPicker set setLabel setWithId show uploadFiles val

Constructors

constructor

Properties

allowedFormats

allowedFormats: string[]

The allowed file types. The file types are defined as an array of extensions.

audioFeedback

audioFeedback: boolean

Enable audio feedback on button click.

buttonLabel

buttonLabel: string

The label text for the uplaod button.

defaultValue

defaultValue: any

deleteOnNotFullfilledCondition

deleteOnNotFullfilledCondition: boolean

Delete all attachments if condition is not fullfilled.

descriptionEnd

descriptionEnd: string

The description text displayed before uploaded files. HTML is allowed.

descriptionStart

descriptionStart: string

The description text displayed before uploaded files. HTML is allowed.

Protected disposed

disposed: boolean

element

element: HTMLElement

enabled

enabled: any

label

label: string

labelEl

labelEl: JQuery<HTMLElement>

maxFileSizeKb

maxFileSizeKb: number

The maximum file size in KB.

maxFileUploads

maxFileUploads: number

The maximum number of files to upload.

maxImagePixel

maxImagePixel: number

The maximum number of pixels for image files.

maxPDFPages

maxPDFPages: number

the maximum number of pages for PDF files.

minFileSizeKb

minFileSizeKb: number

The minimum file size in KB.

minImagePixel

minImagePixel: number

The minimum number of pixels for image files.

multipleUpload

multipleUpload: boolean

Enable multiple file uploads.

onChanged

onChanged: Function

Protected options

options: any

renameFileIfExists

renameFileIfExists: boolean

Suggests a unique file name for the uploaded file if another one with the same name already exists.

required

required: boolean

tooltip

tooltip: string

visiting

visiting: boolean = false

Methods

deleteAllAttachments

  • Delete all files.

    Returns Promise<void>

deleteFields

  • Deletes the all fields related to the form control.

    Parameters

    • name: string

      The field id.

    Returns Promise<any>

deleteFile

  • Delete file by filename.

    Parameters

    • filename: string

      Expects a string.

    Returns Promise<void>

disable

  • Disables the form control.

    Returns void

dispose

  • Disposes the form control.

    Returns void

enable

  • Enables the form control.

    Returns void

get

getAllValues

  • Returns

    all fields and values that are connected with the the form control.

    Returns any

getDefault

  • Gets the default value auf the form control, if it is set.

    Returns any

getPostfixFieldId

  • Gets the PostfixFieldId. Relevant for operations in repeating units. Check first, if the form control is contained in a repeating unit, see: isRepeatingUnit.

    Returns string

getWithId

hide

  • Hide FormControl

    Parameters

    • animate: boolean = false

      En/Disable animation

    • lock: boolean = true

      Enable lock of hidden FormControl to not process control with condition

    Returns void

isRepeatingUnit

  • Checks if the form control is included in a repeating unit.

    Returns boolean

openFileUploadPicker

  • Open file upload dialog.

    Returns Promise<void>

set

  • Sets the field value of the form control. Be careful: This does not update the UI. In most cases it is better to use the val() method, see: val

    Parameters

    • value: any

      The value of the field

    Returns number

setLabel

  • Sets a new label value.

    Parameters

    • value: string

      The value to set.

    Returns void

setWithId

  • Sets any field value by providing its id.

    Parameters

    • id: string

      The id of the field.

    • val: any

      The value of the field. Data type is an object. Its structure depends on the specific field type.

    Returns number

show

  • Show hidden FormControl

    Parameters

    • animate: boolean = false

      En/Disable animation

    • unlock: boolean = true

      Disable lock of hidden state to process control with condition

    Returns void

uploadFiles

  • Upload files.

    Parameters

    • files: File[]

      Expects an array of files.

    • disableOnChanged: boolean = false

      [optional] Disables the onChanged callback if set to true. Necessary if an onChanged-Handler wants to change itself.

    Returns Promise<void>

val

  • Does nothing on the FileUploader.

    Parameters

    • value: any

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc