IMsCompositeFormulaTerm.FormatExpressionText

Fore Syntax

FormatExpressionText(Format: MsTermTextFormat): String;

Fore.NET Syntax

FormatExpressionText[Format: Prognoz.Platform.Interop.Ms.MsTermTextFormat]: string;

Parameters

Format. Name Format.

Description

The FormatExpressionText property returns the name of a composite term in the specified format.

Comments

The following formats are available for composite terms:

MsTermTextFormat.Inversions. Name with term initial transformation and its period specification.
MsTermTextFormat.Screened. Name of the term with the escaped characters. The \ symbol is used for character escaping. If the string contains the \ symbol, the next symbol is recognized as a string.

To apply several formatting parameters, specify the necessary enumeration values MsTermTextFormat through OR.

Fore Example

Executing the example requires the Info composite term passed as a function input parameter. Add a link to the Ms system assembly.

Sub UserProcInfo(Info: IMsCompositeFormulaTerm);
Begin
    Debug.Write("Term name, subject to initial transformation: ");
    Debug.WriteLine(Info.FormatExpressionText(MsTermTextFormat.Inversions));
    Debug.Write("Term name with escaped characters: ");
    Debug.WriteLine(Info.FormatExpressionText(MsTermTextFormat.Screened));
End Sub UserProcInfo;

After executing the example the term name is displayed in the console window in the different formats. For example:

Term name, subject to initial transformation: log(Annual data {2012}[t] * Seasonal variations {2012}[t])

Term name with escaping characters: Annual data \{2012\}[t] * Seasonal fluctuations \{2012\}[t]

Fore.NET Example

Executing the example requires the Info composite term passed as a function input parameter.

Imports Prognoz.Platform.Interop.Ms;
…
Public Shared Sub UserProcInfo(Info: IMsCompositeFormulaTerm);
Begin
    System.Diagnostics.Debug.Write("Term name, subject to initial transformation: ");
    System.Diagnostics.Debug.WriteLine(Info.FormatExpressionText[MsTermTextFormat.mttfInversions]);
    System.Diagnostics.Debug.Write("Term name with escaped characters: ");
    System.Diagnostics.Debug.WriteLine(Info.FormatExpressionText[MsTermTextFormat.mttfScreened]);
End Sub UserProcInfo;

After executing the example the term name is displayed in the console window in the different formats. For example:

Term name, subject to initial transformation: log(Annual data {2012}[t] * Seasonal variations {2012}[t])

Term name with escaping characters: Annual data \{2012\}[t] * Seasonal fluctuations \{2012\}[t]