This documentation is for the old version. Go to the latest Upload Suite docs

UploadProgressDialog.TimeFormat Property

Supported browsers: Internet Explorer

Gets or sets a format of the time displayed in the EstimationText label.

Syntax

PHP
public function getTimeFormat() {
}

public function setTimeFormat($value) {
}

Property Value

Type: string

The time format string having the following syntax:

variable1=value1;variable2=value2;...

The order and case sensitivity are not important. Possible values are:

Appearance
Sets the view. Possible values: Words (XX hours XX minutes XX seconds), ColonSeparated (XX:XX:XX).
PresentDirection
Sets the order of the output of time. Possible values: any possible combinations of H, M and S symbols.
DigitsFormat
Display or not the leading "0", if a particular value is lesser than 10. Possible values: N, NN.
HideZero
Hide or not zero values. Possible values: TRUE, FALSE.

Default value is "Appearance=ColonSeparated; PresentDirection=HMS; DigitsFormat=NN; HideZero=FALSE".

Remarks

Here is an examples of the usage of this property. Say, you set the following value for it:

Appearance=Words;PresentDirection=HMS;DigitsFormat=N;HideZero=TRUE

Then all time values will be displayed like this:

5 minutes 30 seconds

or this:

1 hours 15 minutes 30 seconds

See Also

Reference