ILanerSerie.UserName

Fore Syntax

UserName: Boolean;

Fore.NET Syntax

UserName: boolean;

Description

The UserName property determines whether the user defined a name for the time series.

Comments

Available values:

True. Name of the time series is set by the user.
False. Name of the time series is generated automatically.

Fore Example

Executing the example requires the workbook with the WBK identifier in the repository.

Add links to the Express, Laner and Metabase system assemblies.

Sub UserProc;
Var
    mb: Imetabase;
    Eax: IEaxAnalyzer;
    Laner: ILaner;
    Series: ILanerSeries;
    i: Integer;
    Serie: ILanerSerie;
Begin
    mb := MetabaseClass.Active;
    Eax := mb.ItemById("WBK").Bind As IEaxAnalyzer;
    Laner := Eax.Laner;
    Series := Laner.Series;
    Debug.WriteLine("Names of series:");
    For i := 0 To Series.Count - 1 Do
        Serie := Series.Item(i);
        Debug.Write(Serie.Name);
        If Serie.UserName Then
            Debug.WriteLine(" (set by the user)");
        Else
            Debug.WriteLine(" (automatically generated)");
        End If;
    End For;
End Sub UserProc;

After executing the example the console window displays names of workbook series and the method of name creation.

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example.

Imports Prognoz.Platform.Interop.Express;
Imports Prognoz.Platform.Interop.Laner;
…
Public Shared Sub Main(Params: StartParams);
Var
    mb: Imetabase;
    Eax: IEaxAnalyzer;
    Laner: ILaner;
    Series: ILanerSeries;
    i: Integer;
    Serie: ILanerSerie;
Begin
    mb := Params.Metabase;
    Eax := mb.ItemById["WBK"].Bind() As IEaxAnalyzer;
    Laner := Eax.Laner;
    Series := Laner.Series;
    System.Diagnostics.Debug.WriteLine("Names of series:");
    For i := 0 To Series.Count - 1 Do
        Serie := Series.Item[i];
        System.Diagnostics.Debug.Write(Serie.Name);
        If Serie.UserName Then
            System.Diagnostics.Debug.WriteLine(" (set by the user)");
        Else
            System.Diagnostics.Debug.WriteLine(" (automatically generated)");
        End If;
    End For;
End Sub;