​.UpdateInProgress Dotfield

The .UpdateInProgress dotfield indicates the current status of a historical trend update operation. The value of the dotfield is set to 1 if a historical retrieval is in progress; otherwise the dotfield is set to 0.

Category

Historical.

Usage

HistTrendTag.UpdateInProgress

Parameter

HistTrendTag

HistTrend tag assigned the name of the trend.

Remarks

Whenever new data is requested from the historical trend, this dotfield's value is set to 1. After the process completes, .UpdateInProgress is reset to 0. .UpdateInProgress can be used in functions related to historical trends.

If the operator scrolls the trend to a period outside the currently shown period, it can take some time to retrieve the historical data. The .UpdateInProgress dotfield provides a way to alert the operator that the requested data is being retrieved. Without feedback, the operator may not be aware that the trend is being updated.

Data Type

Discrete (read-only).

Value Values

0 = No update in progress

1 = Update in progress

Example

The .UpdateInProgress dotfield is typically used as the expression in a visibility link on a text object near or on the scroll buttons of a Historical Trend. You can use the .UpdateInProgress dotfield to show "Busy" on the window when the data is being retrieved with the following message value display animation link:

DText(HistTrend1.UpdateInProgress,"Busy","Ready")

See Also

.UpdateCount, .UpdateTrend