2.4.839 BrtTop10Filter

The BrtTop10Filter record specifies the criteria for a top N filter.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

A

B

C

reserved

xNumValue

...

...

xNumFilter

...

...

A - fTop (1 bit): A bit that specifies whether the top or bottom items are displayed. This field MUST be one of the values specified in the following table.

Value

Meaning

0

Bottom items are displayed.

1

Top items are displayed.

B - fPercent (1 bit): A bit that specifies whether a percentage of top or bottom items are displayed, or a set number of top or bottom items are displayed. This field MUST be one of the values specified in the following table.

Value

Meaning

0

Top or bottom n items are displayed.

1

Top or bottom n percent of items are displayed.

C - fApplied (1 bit):  A bit that specifies whether the filter has been applied. This field MUST be one of the values specified in the following table.

Value

Meaning

0

xNumFilter needs to be recalculated, and the filter is not applied.

1

xNumFilter exists among the range of cells and is correctly calculated value, and the filter is applied.

reserved (5 bits): This value MUST be 0, and MUST be ignored.

xNumValue (8 bytes): An Xnum (section 2.5.172) that specifies the value applied in the filter. This value specifies the top or bottom xNumValue number or percent of items that will be displayed when the filter is applied. For example, if this filter is a "top 13 items" filter, then the value of this field would be 13. If this filter is applied to a PivotTable (section 2.1.7.40) then this value MUST be greater than or equal to 0. Otherwise this value MUST be greater than or equal to 1 and less than or equal to 500.

xNumFilter (8 bytes):  An Xnum that specifies the cell value in the range of cells that is used to perform the comparison for this filter. This value is calculated at the time the filter is applied. For example, if the filter is a top filter, then all items greater than or equal to the value stored in this field are displayed. If it is a bottom filter, all items less than or equal to this value are displayed. If fApplied is 1, this value MUST be a valid value in the range of cells which the filter is applied to.