IEaxWorkbookRubricatorOptionsList.Remove

Syntax

Remove(RubricatorKey: Integer): Boolean;

Parameters

RubricatorKey. Key of time series database.

Description

The Remove method deletes settings for the specified time series database

Comments

If delete is successful, the method returns True, otherwise it returns False. Use the IEaxWorkbookRubricatorOptionsList.Clear method to delete all settings from the collection.

Example

Executing the example requires a form, the LanerBox component and the UiErAnalyzer component with the UiErAnalyzer1 identifier, that is a data source for LanerBox. Workbook of the time series database must be loaded to UiErAnalyzer1.

Add links for the Express and Cubes system assemblies.

Sub procRemove;
Var
    Ea: IEaxAnalyzer;
    Wb: IEaxWorkbook;
    WbTree: IEaxWorkbookMetaAttributesTree;
    Laner: ILaner;
    Rub: IRubricator;
    RubKey: Integer;
    OpList: IEaxWorkbookRubricatorOptionsList;
    Res: Boolean;
Begin
    // Receiving workbook
    Ea := UiErAnalyzer1.ErAnalyzer;
    Wb := Ea As IEaxWorkbook;
    // Receiving object tree settings
    WbTree := Wb.MetaAttributesTree;
    Laner := Ea.Laner;
    Rub := Laner.RubricatorInstance.Rubricator;
    RubKey := (Rub As IMetabaseObjectDescriptor).Key;
    // Get directory settings, connected to the indicators tree
    OpList := WbTree.RubricatorsOptions;
    Res := OpList.Remove(RubKey);
    If Res Then
        Debug.WriteLine(Delete completed successfully);
    Else
        Debug.WriteLine(Selected time series database is not configured);
    End If;
    (Ea As IMetabaseObject).Save;
End Sub procRemove;

The settings of time series database for the workbook, loaded to LanerBox, are deleted when example is executed. Delete result is shown in the console window.