ILaner.ValueFootnoteAttributes

Fore Syntax

ValueFootnoteAttributes: ILanerCellAttributes;

Fore.NET Syntax

ValueFootnoteAttributes: Prognoz.Platform.Interop.Laner.ILanerCellAttributes;

Description

The ValueFootnoteAttributes property returns collection of attributes used to create data area footnotes.

Fore Example

Executing the example requires that the repository contains a workbook with the WORKBOOK identifier containing several series. The workbook must use the time series database that contains mandatory attribute of series with the INDICATOR identifier as a data source.

Sub UserProc;
Var
    MB: IMetabase;
    WbkObj: IMetabaseObject;
    Laner: ILaner;
    FootnoteAttributes: ILanerCellAttributes;
Begin
    // Get workbook
    MB := MetabaseClass.Active;
    WbkObj := MB.ItemById("WORKBOOK").Edit;
    Laner := (WbkObj As IEaxAnalyzer).Laner;
    // Get collection of footnote attributes for series headers
    FootnoteAttributes := Laner.ValueFootnoteAttributes;
    // Clear collection
    FootnoteAttributes.Clear;
    // Add the "COUNTRY" attribute into collection of prefix attributes
    FootnoteAttributes.Add("COUNTRY", LnAttributeType.Fact);
    // Save changes
    WbkObj.Save;
End Sub UserProc;

After executing the example footnotes are added for workbook data. Footnote text is created by values of the COUNTRY series attribute.

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;
    FootnoteAttributes: ILanerCellAttributes;
Begin
    // Get workbook
    MB := Params.Metabase;
    WbkObj := MB.ItemById["WORKBOOK"].Edit();
    Laner := (WbkObj As IEaxAnalyzer).Laner;
    // Get collection of footnote attributes in data area
    FootnoteAttributes := Laner.ValueFootnoteAttributes;
    // Clear collection
    FootnoteAttributes.Clear();
    // Add the "COUNTRY" attribute into collection of prefix attributes
    FootnoteAttributes.Add("COUNTRY", LnAttributeType.latFact);
    // Save changes
    WbkObj.Save();
End Sub;

See also:

ILaner

Related work items

Requirement