Upload component interface

Hierarchy

Properties

ButtonText: string

The button label for the upload button.

Classes: string[]

Additional CSS classes to add to the control.

DataType?: string

The data type which should be allowed to be uploaded. Can be null. But if set, the event will only fire when the upload has the correct matching type.

Enabled: boolean

Enabled state of the UI element. When the type supports this, the UI element will be disabled when set to false.

Id: string

The id of the UI element.

Name: string

Name of the UI element. For form fields that would be the name otherwise used for reference only.

OnUpload: ((self, event, upload) => void)

Type declaration

    • (self, event, upload): void
    • The event which is fired when a file is uploaded.

      Parameters

      • self: MEUIUpload

        The upload component.

      • event: "Upload"

        This will always be "Upload".

      • upload: MEUIUploadFile

        The uploaded file.

      Returns void

ParentClasses: string[]

Additional CSS classes to add to the parent control when supported.

StandardClasses: string[]

The standard classes of the control. Modify this property only if you know what you are doing.

Tags: string[]

Tags for the UI element. Used for reference only.

TextDirection: TextFieldTextDirection

The text direction of the UI element. Defaults to Inherit, meaning it will use the editor default.

ToolTip?: string

Tooltip text of the UI element.

Type: "Upload"

The type of the UI element. Always "Upload".

Visible: boolean

Visibility flag of the UI element. When not visible it will be hidden from the UI.

Generated using TypeDoc