IPivotHeaderFilterSettings.ExcludeElements

Fore Syntax

ExcludeElements: Boolean;

Fore.NET Syntax

ExcludeElements: boolean;

Description

The ExcludeElements property determines whether elements are excluded from filtering settings.

Comments

Available values:

True. Elements are excluded from filtering settings.
False. Elements are not excluded from filtering settings.

To exclude elements by selection, use IPivotHeaderFilterSettings.ExcludeSelection.

Fore Example

Executing the example requires that the repository contains a regular report with the EXPRESS_FILTER identifier. The report contains a table.

Add links to the Dimensions, Express, Metabase, Pivot system assemblies.

Sub UserProc;
Var
    MB: IMetabase;
    Express: IEaxAnalyzer;
    Pivot: IPivot;
    DimSel: IDimSelection;
    LeftHeader: IPivotHeader;
    LeftFilter: IPivotHeaderFilterSettings;
    Filter: IPivotFilter;
Begin
    // Get repository
    MB := MetabaseClass.Active;
    // Get express report
    Express := MB.ItemById("EXPRESS_FILTER").Edit As IEaxAnalyzer;
    // Get table display settings
    Pivot := Express.Pivot;
    //Filtering parameters in table
    Filter := Pivot.Filter;
    // Dimensions located by rows
    LeftHeader := Pivot.LeftHeader;
    // Get filtering parameters for row headers
    LeftFilter := LeftHeader.Settings.Filter;
    // Exclude selection
    DimSel := Pivot.Selection.Item(0);
    LeftFilter.ExcludeSelection := DimSel;
    LeftFilter.ExcludeElements := True;
    // Save changes
    (Express As IMetabaseObject).Save;
End Sub UserProc;

After executing the example filtering is not applied to the excluded selection.

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example.

Imports Prognoz.Platform.Interop.Dimensions;
Imports Prognoz.Platform.Interop.Express;
Imports Prognoz.Platform.Interop.Pivot;
…
Public Shared Sub Main(Params: StartParams);
Var
    MB: IMetabase;
    Express: IEaxAnalyzer;
    Pivot: IPivot;
    DimSel: IDimSelection;
    LeftHeader: IPivotHeader;
    LeftFilter: IPivotHeaderFilterSettings;
    Filter: IPivotFilter;
Begin
    // Get repository
    MB := Params.Metabase;
    // Get express report
    Express := MB.ItemById["EXPRESS_FILTER"].Edit() As IEaxAnalyzer;
    // Get table display settings
    Pivot := Express.Pivot;
    //Filtering parameters in table
    Filter := Pivot.Filter;
    // Dimensions located by rows
    LeftHeader := Pivot.LeftHeader;
    // Get filtering parameters for row headers
    LeftFilter := LeftHeader.Settings.Filter;
    // Exclude selection
    DimSel := Pivot.Selection.Item[0];
    LeftFilter.ExcludeSelection := DimSel;
    LeftFilter.ExcludeElements := True;
    // Save changes
    (Express As IMetabaseObject).Save();
End Sub;