2023-07-31 11:01:44 +00:00
caption: tm-download-file
2014-08-11 12:17:11 +00:00
created: 20140811112201235
2023-07-31 11:01:44 +00:00
modified: 20230723214745520
2014-09-11 14:52:47 +00:00
tags: Messages
2014-08-28 20:43:44 +00:00
title: WidgetMessage: tm-download-file
2014-08-15 09:06:19 +00:00
type: text/vnd.tiddlywiki
2014-08-11 12:17:11 +00:00
The download file message causes the current saver module to prompt the user to download the result of parsing a specified template tiddler as a file. It requires the following properties on the `event` object:
|!Name |!Description |
|param |Title of a tiddler to use as a template for the new tiddler |
2023-07-31 11:01:44 +00:00
|//{any other params}// |Any other parameters are made available as variables within the context of the widget message. |
2014-08-11 12:17:11 +00:00
2022-01-23 18:35:38 +00:00
The following variable names have special behaviour:
|!Name |!Description |
|filename |Filename for the downloaded file (note that this is a hint to the browser, and the actual filename used may be different) |
2014-08-11 12:17:11 +00:00
The download file message is usually generated with the ButtonWidget.
The download file message is handled by the TiddlyWiki core SyncMechanism which invokes the current [[SaverModule|SaverModules]].
