FileUploader Type

File uploader control type. A control for uploading files such as images.

Hierarchy

Value
   └─ FileUploader

Index

Properties

Methods

Events

Properties

container

container: boolean (optional)

True if the control is a container.

Inherited from Control.container

generic

generic: boolean (optional)

Inherited from Control.generic

getDataSource

getDataSource: function(): any

Inherited from Control.getDataSource

hidden

hidden: boolean

True if the control is hidden.

Inherited from Control.hidden

image

image: Image

Methods

applyDesign

applyDesign(IDesign: FileUploaderDesign): void

Applies given design to the design on the control. If a design already exists, the prototype chain of the design will be preserved.

Overrides Control.applyDesign

Parameters

Name Type Description
IDesign FileUploaderDesign object containing design properties as keys

Returns void

canLoadFromDevice

canLoadFromDevice(): boolean

Returns true if the mobile phone has camera plugin.

Returns boolean

dataContext

dataContext(): any

Inherited from Control.dataContext

Returns any

getDesign

getDesign(): Design

Returns the design object of this control.

Inherited from Control.getDesign

Returns Design

getImage

getImage(options: any): Promise <string>

Returns a promise of an object with image data.

Parameters

Name Type Description
options any see camera options

Returns Promise <string>

getValue

getValue(): any

Gets the value of the entity that is bound to the control.

Overrides Value.getValue

Returns any

isEditable

isEditable(): boolean

Boolean indicating if the control is editable. Returns false when either the control or it's parent is not editable. Returns true when both the control and it's parent are editable. Returns true when either the control or it's parent is editable and the other is undefined. Returns undefined if both the control's edit-ability and it's parent's edit-ability is undefined.

Inherited from Control.isEditable

Returns boolean

loadFromFileSystem

loadFromFileSystem(file: Blob): Promise <any>

Parameters

Name Type Description
file Blob

Returns Promise <any>

metadata

metadata(): FileUploaderMetadata

Returns the metadata object of this control.

Overrides Value.metadata

Returns FileUploaderMetadata

parent

parent(): Control | Page

Returns the parent (control or page) of this control.

Inherited from Control.parent

Returns Control | Page

root

root(): Page

Returns the root form instance (page) of this control.

Inherited from Control.root

Returns Page

setCamera

setCamera(camera: any): void

Set the camera object on the control.

Parameters

Name Type Description
camera any

Returns void

setValue

setValue(value: string): void

Sets the value of the control.

Inherited from Value.setValue

Parameters

Name Type Description
value string

Returns void

Events

onDataChanged

onDataChanged: EventHook <null>

An event that is triggered when the input control's data changes.

Inherited from InputControl.onDataChanged