The FILEDOWNLOAD component is an invisible component that performs a download of data from the server when being triggered. After the download is executed the browser will inform the user and will allow the user to store the downloaded data locally within the client.
The data that is downloaded is taken from the URL that you pass into this component.
Typically used attributes
All attributes are
General attributes are
Used inside: BEANPROCESSING
Text that is passed as control content to the accessible support devices (e.g. screen readers).
Binding to server side method that processes the events coming from this component.
#{methodBinding} | Method binding |
Special binding to component adapter object instance on server side. The component adapter must be an instance of IComponentAdapterBinding. For some components (e.g. FIXGRID) there is an extended interface (e.g. IFIXGRIDComponentAdapterBinding).
#{tobedefined} | Binding to IComponentAdapter instance |
Asynchronouse download. If switched to true then the file will be downloaded asynchronously - the user can continue with the application while the file be downloaded in parallel.
false | Synchronous download (default) |
true | Asynchronous download |
Name of macro that is used for generating certain attributes of this component. Please pay attention: the value of this attribute is read one time for each control and cannot be changed afterwards.
Name that is assigned to the component at client side: there is no specific function associated with the name - but it can be used on client side to describe the component in a clearer way. The name is e.g. used by UI test tools that replay certain user interaction sequences - and that reference components via their name.
Spanning of columns if used inside a COLSYNCHEDROW or inside a GRIDLAYOUTPANE.
1 | Control spans one column (default) |
2 | 2 columns |
3 | 3 columns |
Filter for commands that are executed on client level as part of the client message management. The actionListener is invoked if a command matches the commandfilter. The messages (each message assocaited with a command) are thrown either by the server side application or are generated on client side, by using the MessageBus* framework.
eclntNoActivity5 | 5 seconds of no-user-activity |
eclntNoActivity10 | 10 seconds of no-user-activity |
anyApplicationCommand | Any application command from server side. |
Comment that can be asigned to any component. The comment is not operationally used.
Any text | Any text |
Configuration information that is attached to this component. This information is not functionally used by CaptainCasa, but may be used for any application specific purpose.
Semicolon separated list of file extensions which is used as filter within the file selection dialog.
Default - all files. | |
txt | Only files with extension .txt |
jpg;png;gif | Only image files |
Reference to an outside object that is the content behind the component. E.g. a field is representing a certain field of a database table: in this case you could define the value table;column. The reference plays a siginficant role within the attributemacro management.
ref | One reference |
ref1;ref2 | Two references |
ref1;ref2;ref3 | Three references |
Flag that indicated if this component is rendered at all. If set to false then the component is not rendered - there is no component data sent to the client.
true | Component is rendered (default) |
false | Component is not rendered |
Spanning of rows if used inside a GRIDLAYOUTPANE.
1 | Control spans one row (default) |
2 | 2 rows |
3 | 3 rows |
Trigger value: if the value changes then the component's activity is executed on client side. Use class Trigger on server side for implementations of this property.
URL that is loaded. Either an absolute address, or relative to the jsp starting page.
When true then the component will do a callback to the server and invoke the actionListener after having successfully performed the client operation.
false | No callback to server (default) |
true | Callback to server |
x-pixel-position: this attribute is only used if the component is directly placed into a PAINTAREA!
y-pixel-position: this attribute is only used if the component is directly placed into a PAINTAREA!