FileDownloader.TimeFormat Property

Supported browsers: Internet Explorer

List of parameters that specify how time values of the progress bar will be displayed.

Syntax

Initialize

JavaScript

<script type="text/javascript" src="iuembed.js">  </script>
<script type="text/javascript">
var fd = new FileDownloaderWriter("FileDownloaderID", 610, 500);
//...other params...
fd.addParam("TimeFormat", "Appearance=Words; PresentDirection=HMS; DigitsFormat=N; HideZero=TRUE");
//...other params...
fd.writeHtml();
</script>

Get/Set Value in Runtime

JavaScript

getFileDownloader("FileDownloaderID").setTimeFormat(value);
value = getFileDownloader("FileDownloaderID").getTimeFormat();

Property Value

A string value that specifies the format of time values displayed in the progress dialog. See the Remarks section for more detailed description of this string. If an empty string is specified, the default value is used.

Default value is "Appearance=Words; PresentDirection=HMS; DigitsFormat=N; HideZero=TRUE".

Remarks

This property should be used if you want to change the default time format. The syntax of the value string is as follows:

variable1=value1; variable2=value2; ...

Here is the list of available variables:

Variable	Possible values	Description
Appearance	`Words` or `ColonSeparated`	Sets the general format. If the value is `Words`, it will be a text format, for example, `1 minute 25 seconds`. If the value is `ColonSeparated`, it will be a colon-separated format, for example, `00:01:25`.
PresentDirection	Any possible combination of `H`, `M`, and `S` symbols	Sets the order of time units. `H` is for hours, `M` is for minutes, and `S` is for seconds.
DigitsFormat	`N` or `NN`	Adds or omits `0`, if the output value is less that `10`. If the value is `N`, `0` will be omitted. If the value is `NN`, `0` will be kept.
HideZero	`true` or `false`	Hides or shows zero time units. If the value is `true`, zero time units will be hidden, for example, `1 minute 25 seconds`. If the value is `false`, zero time units will be displayed, for example, `0 hours 1 minute 25 seconds`.

Note

The value string is case insensitive.