IMsFormulaTermInfo.FormatText

Syntax

FormatText(format: MsTermTextFormat): String;

Parameters

format. Term name view format.

Description

The FormatText method transforms and returns term name in the specified format.

Comments

To apply several formatting parameters, specify the necessary enumeration values MsTermTextFormat via Or.

Example

Executing the example requires the presence of the Info term.

Add a link to the Ms system assembly.

Sub UserProc;
Var
    Info: IMsFormulaTermInfo;
Begin
    Info.Inversion := MsInversion.DLog;
    Info.InversionLag := MsInversionLag.PrecidingYear;
    Info.Lag := "2";
    Debug.WriteLine(Name of term:  + Info.TermText);
    Debug.WriteLine(Name of term without brackets:  + Info.FormatText(MsTermTextFormat.Brackets));
    Debug.WriteLine(Name of term with indication of source of data:  + Info.FormatText(MsTermTextFormat.DataSource));
    Debug.WriteLine(Name with indication of beginning transformation of term and its period:  + Info.FormatText(MsTermTextFormat.Inversions));
    Debug.WriteLine(Name of term with indication of lag:  + Info.FormatText(MsTermTextFormat.Time));
End Sub UserProc;

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

Term name: {dlogYoY(TEST_COPY1!Afghanistan|BCA[t+2], 3)}

Term name without brackets: Afghanistan|BCA

Term name with the indication of data source: TEST_COPY1!Afghanistan|BCA

Name with indication of initial transformation of term and its period: dlogYoY(TEST_COPY1!Afghanistan|BCA[t+2], 3)

Term name with lag indication: Afghanistan|BCA[t+2]