ILanerLeftHeader.FootnoteValues

Fore Syntax

FootnoteValues(SlotIndex: Integer; ElementIndex: Integer): Array;

Fore.NET Syntax

FootnoteValues[SlotIndex: Integer; ElementIndex: Integer]: Array;

Parameters

SlotIndex. Index of the header slot.

ElementIndex. Index of the header element.

Description

The FootnoteValues property returns an array containing values of footnotes created for the specified header element.

Comments

To create footnotes, determine the ILaner.SerieFootnoteAttributes property.

Fore Example

Executing the example requires that the repository contains a workbook with the WORKBOOK identifier. Footnotes for series headers are created in the workbook.

Sub UserProc;
Var
    MB: IMetabase;
    WbkObj: IMetabaseObject;
    Laner: ILaner;
    Header: ILanerLeftHeader;
    s, e: Integer;
Begin
    //Get workbook
    MB := MetabaseClass.Active;
    WbkObj := MB.ItemById("WORKBOOK").Bind;
    Laner := (WbkObj As IEaxAnalyzer).Laner;
    //Calculate workbook
    Header := Laner.Execute.LeftHeader;
    //View footnote values
    For s := 0 To Header.SlotCount - 1 Do
        For e := 0 To Header.ElementCount - 1 Do
            Debug.WriteLine(Header.FootnoteValues(s, e)[0])
        End For;
    End For;
End Sub UserProc;

After executing the example the development environment console displays the first footnotes added for series headers.

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;
Imports Prognoz.Platform.Interop.Metabase;
…
Public Shared Sub Main(Params: StartParams);
Var
    MB: IMetabase;
    WbkObj: IMetabaseObject;
    Laner: ILaner;
    Header: ILanerLeftHeader;
    s, e: Integer;
Begin
    //Get workbook
    MB := Params.Metabase;
    WbkObj := MB.ItemById["WORKBOOK"].Bind();
    Laner := (WbkObj As IEaxAnalyzer).Laner;
    //Calculate workbook
    Header := Laner.Execute().LeftHeader;
    //View footnote values
    For s := 0 To Header.SlotCount - 1 Do
        For e := 0 To Header.ElementCount - 1 Do
            System.Diagnostics.Debug.WriteLine(Header.FootnoteValues[s, e][0])
        End For;
    End For;
End Sub;