Setting Up Event Handling

The event handler sends express report parameters used for calculation and enables the user to perform the action determined by the code on each event occurrence.

Handling of events occurred on working with report can be set up for express reports:

To execute the example, create a unit and connect it as event handler for express reports. Connect the Dimensions, Export, Express, Forms, Metabase system assemblies in the unit. Add event handlers:

Public Class EventsClass: ExpressEvents
param_comment: string;

Public Sub OnAfterExecuteAnalyzer(Args: IEaxAfterExecuteEventArgs);
Var DSSet: IDimSelectionSet;
Begin
    DSSet := args.AnalyzerData.SheetData.Selection;
    // get list line of selected elements in express report dimensions
    param_comment := GetEaXReportParams(DSSet);
    // add record to access protocol with necessary comment
    args.AnalyzerData.Descriptor.CheckAndAudit(2, "Report execution." + param_comment);
End Sub OnAfterExecuteAnalyzer;

Public Sub OnAfterPrintAnalyzer(Args: IEaxAfterPrintEventArgs);
Var DSSet: IDimSelectionSet;
Begin
    DSSet := args.AnalyzerData.SheetData.Selection;
    param_comment := GetEaXReportParams(DSSet);
    debug.WriteLine(param_comment);
End Sub OnAfterPrintAnalyzer;

Public Sub OnAfterExportAnalyzer(Args: IEaxAfterExportEventArgs);
Var DSSet: IDimSelectionSet;
Begin
    DSSet := args.AnalyzerData.SheetData.Selection;
    param_comment := GetEaXReportParams(DSSet);
    debug.WriteLine(param_comment);
End Sub OnAfterExportAnalyzer;

End Class EventsClass;

// get list string of selected elements in express report dimensions
Public Function GetEaXReportParams(ExArDsset: IDimSelectionSet): string;
Var ControlStr: string;
    i, DimCnt: integer;
    DimName: string;
    selection: idimselection;
Begin
    dimCnt := ExArDsset.Count;
    ControlStr := "Report parameters: ";
    For i := 0 To dimCnt - 1 Do

        DimName := ExArDsset.Item(i).Dimension.Name;
        ControlStr := ControlStr + DimName + ": ";
        selection := ExArDsset.Item(i);
        If selection.SelectedCount = 0 Then
            ControlStr := ControlStr + ": <not selected>. ";
            Else
            ControlStr := ControlStr + ": " + Selection.ToString;
        End If;
    End For;
    Return ControlStr;
End Function GetEaXReportParams;

After executing the example, when table update event occurs, the information about selected dimensions is recorded to the access protocol. On printing and export information is selected and displayed in the development console. Example of line:

Note: Report execution. Report parameters: Facts: : CountryFact: : Albania,Belgium,Bosnia and Herzegovina,Croatia,Cyprus,Czech Republic,Grenland,Hungary,Italy,Latvia Factors: : GDP Growth (% yearly)Calendar: : 2005,2006,2007,2008,2009,2010

Global Handler of Update Events

NOTE. The class must inherit the UpdateCallBack class and contain the method with the following signature:
Function OnCallBack(<param1>: MetabaseUpdateCallbackReason; <param1>: IMetabaseUpdate) : Boolean.

To execute the example, create a unit and connect it as event handler for update events. Add a link to the Metabase system assembly in the unit. Add an event handler.

Public Class UpdateHandlerClass: UpdateCallBack
    Function OnCallback(Reason: MetabaseUpdateCallbackReason; Update: IMetabaseUpdate): Boolean;
    Begin
        //Check update application modes
        Select Case Reason
            Case MetabaseUpdateCallbackReason.ApplyCoreEnd: //actions after finishing update application from core
            Case MetabaseUpdateCallbackReason.ApplyCoreStart: //actions on calling update application from core
            Case MetabaseUpdateCallbackReason.ApplyUI: //actions on calling update application from interface
            Case MetabaseUpdateCallbackReason.SaveUI: //actions on calling update saving from interface
            Case MetabaseUpdateCallbackReason.SaveCore: //actions on calling update saving from core
            Case MetabaseUpdateCallbackReason.LoadCoreEnd: //actions on finishing reading update from core
        End Select;
        return False; //without interrupting system action
    End Function OnCallback;
End Class UpdateHandlerClass;

The example execution result depends on the specified actions for MetabaseUpdateCallbackReason calculation.

Setting Up Event Handling

Global Handler of Report Calculation

Global Handler of Update Events