2.4.247 BrtBeginSXFILTER

The BrtBeginSXFILTER record specifies properties of an advanced filter (section 2.2.5.3.6.1) and specifies the beginning of a collection of records as defined by the PivotTable (section 2.1.7.40) part ABNF. The collection of records specifies a PivotTable (section 2.2.5) advanced filter.

isxvd (4 bytes): An ISXVD (section 2.5.84) that specifies the pivot field (section 2.2.5.3.2) to which this advanced filter applies. This value MUST NOT be equal to -1 or -2.

isxvdMProp (4 bytes): An ISXVD that specifies the pivot field specifying the member property on which this advanced filter is based. This value is only used by label filters (section 2.2.5.3.6.1.1). If this advanced filter is a label filter, as specified by sxft, and this advanced filter is based on a member property, then this value MUST be greater than or equal to 0. Otherwise, it MUST be -1 and MUST be ignored.

sxft (4 bytes): A PivotFilterType (section 2.5.104) that specifies the type of this advanced filter.

unused (4 bytes):  This value is undefined and MUST be ignored.

dwId (4 bytes):  An unsigned integer that specifies the unique identifier of this advanced filter.

isxdiMeasure (4 bytes): An ISXDI (section 2.5.82) that specifies the data item (section 2.2.5.3.7.5.1) on which this value filter (section 2.2.5.3.6.1.3) is based. If this advanced filter is a value filter, as specified by sxft, and this advanced filter is associated with a non-OLAP PivotTable (section 2.1.7.40), then this value MUST be greater than or equal to 0. Otherwise, it MUST be -1 and MUST be ignored.

isxthMeasure (4 bytes): An ISXTH (section 2.5.83) that specifies the pivot hierarchy (section 2.2.5.3.4) used by this advanced filter. The pivot hierarchy this value specifies MUST have an associated cache hierarchy (section 2.2.5.2.7) with the fMeasure field equal to 1. If this advanced filter is a value filter, as specified by sxft, and this advanced filter is associated with an OLAP PivotTable (section 2.1.7.40), then this value MUST be greater than or equal to 0. Otherwise, it MUST be -1 and MUST be ignored.

A - fLoadName (1 bit):  A bit that specifies whether stName exists.

B - fLoadDescription (1 bit):  A bit that specifies whether stDescription exists.

C - fLoadVal1 (1 bit):  A bit that specifies whether stVal1 exists. This value MUST be 1 if and only if this advanced filter is a label filter (section 2.2.5.3.6.1.1), as specified by sxft.

D - fLoadVal2 (1 bit):  A bit that specifies whether stVal2 exists. This value MUST be 1 if and only if this advanced filter is of type "is between" or "is not between", as specified by sxft.

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

stName (variable):  An optional XLWideString (section 2.5.169) that specifies the name of this filter. The length of this value MUST be less than 65,536. This value MUST exist if and only if fLoadName is equal to 1.

stDescription (variable):  An optional XLWideString that specifies the description of this advanced filter. The length of this value MUST be less than 65,536. This value MUST exist if and only if fLoadDescription is equal to 1.

stVal1 (variable):  An optional XLWideString that specifies the first string value used by label filters. The length of this value MUST be less than 65,536. This value MUST exist if and only if fLoadVal1 is equal to 1.

stVal2 (variable):  An optional XLWideString that specifies the second string value used by label filters. The length of this value MUST be less than 65,536. This value MUST exist if and only if fLoadVal2 is equal to 1.