IMsStringGenerator.HideModelPeriods

Fore Syntax

HideModelPeriods: Boolean;

Fore.NET Syntax

HideModelPeriods: boolean;

Description

The HideModelPeriods property determines whether to hide the calculation period in the string view.

Comments

Available values:

True. The calculation period is not included in the string view. For example: Arhentina|NGDP[t] = Arhentina|BCA[t].
False. The default value. The calculation period is included in the string view. On generating the string view, the parameters and conditions applied for determining the calculation period. For example:

Method of determining the calculation period	Example of string view
Calculation period is set by certain dates	Arhentina\|NGDP[t] = Arhentina\|BCA[t], 2014A1-2020A1
The calculation period is set by certain dates and one of them is the parameter	Arhentina\|NGDP[t] = Arhentina\|BCA[t], 2014A1-{EndDate}
Sample period start is determined by the condition: Start of data +/-k periods. Today +/-k periods. From the sample period end +/-k periods.	Arhentina\|NGDP[t] = Arhentina\|BCA[t], (Data start +/-k)-2020A1. Arhentina\|NGDP[t] = Arhentina\|BCA[t], (Today +/-k)-2020A1. Arhentina\|NGDP[t] = Arhentina\|BCA[t], (From sample end +/-k)-2020A1.
Sample period end is determined by the following condition: Start of data +/-k periods. End of data +/-k periods. Today +/-k periods. From sample start +/-k periods.	Arhentina\|NGDP[t] = Arhentina\|BCA[t], (Data start +/-k)-2020A1 Arhentina\|NGDP[t] = Arhentina\|BCA[t], (Data end +/-k)-2020A1 Arhentina\|NGDP[t] = Arhentina\|BCA[t], (Today +/-k)-2020A1 Arhentina\|NGDP[t] = Arhentina\|BCA[t], (From sample start +/-k)-2020A1
Forecasting period end is determined by the condition: End of data +/-k periods. From the sample period end +/-k periods. Today +/-k periods.	Arhentina\|NGDP[t] = Arhentina\|BCA[t], 2014A1-(Data end +/-k). Arhentina\|NGDP[t] = Arhentina\|BCA[t], 2014A1-(From sample end +/-k). Arhentina\|NGDP[t] = Arhentina\|BCA[t], 2014A1-(Current date +/-k).
All cases when two dates are set by using conditions	Arhentina\|NGDP[t] = Arhentina\|BCA[t], (Data start +/-k)-(Current date +/-k)
All cases when one date is set by the parameter and another by the condition	Arhentina\|NGDP[t] = Arhentina\|BCA[t], (Data start +/-k)-{EndDate}

Fore and Fore.NET Examples

The property use is given in the example for IMsModel.AutoName.

See also:

IMsStringGenerator