ILanerBox.IsOptionSwitchedOn

Syntax

IsOptionSwitchedOn(Operation: LanerBoxOperation): Boolean;

Parameters

Operation . Operation performed on the workbook.

Description

The IsOptionSwitchedOn method indicates whether the specified operation is applied in the workbook.

Comments

IsOptionSwitchedOn is used for the following operations:

For multidimensional workbook mode:
- LanerBoxOperation.Pareto. Pareto analysis.
- LanerBoxOperation.Filter. Empty cells filter.
- LanerBoxOperation.Colorer. Highlight cells.
For series mode of the workbook:
- LanerBoxOperation.PinSelectedCalcSerie. Fix calculated series.

Available Values of IsOptionSwitchedOn:

True. Operation is used in the workbook.
False. Operation is not used in the workbook.

Example

Executing this example requires a form with a button named Button1 positioned on this form, the LanerBox component named LanerBox1, and the UiErAnalyzer component used as a data source for LanerBox. The workbook of the time series database is to be loaded to UiErAnalyzer in multidimensional mode.

This procedure is to be assigned as a handler of the OnClick event for this button. The example is executed on clicking the button.

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
Begin
    If Not LanerBox1.IsOptionSwitchedOn(LanerBoxOperation.Pareto) Then
        LanerBox1.ExecuteOperation(LanerBoxOperation.Pareto);
    End If;
End Sub Button1OnClick;

After executing this example Pareto analysis is applied to the workbook displayed in LanerBox.