Download interface

Hierarchy

Properties

ButtonText: string

The button label text.

Classes: string[]

Additional CSS classes to add to the control.

Data: string

The data to download. Binary formats must be in Base64 (see https://developer.mozilla.org/en-US/docs/Glossary/Base64).

DataType: string

The data type of the download. Defaults to "text/plain". See valid mime types: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

Enabled: boolean

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

FileName: string

The file name of the download as suggested as the default by the browser. Defaults to "download.txt".

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.

OnDownload: ((download) => void)

Type declaration

    • (download): void
    • Registers a callback for the download event when the download is initiated.

      Parameters

      • download: MEUIDownload

        The download component where a download was initiated.

      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: "Download"

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

Visible: boolean

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

Generated using TypeDoc