2.5.111 PRuleHeaderData
The PRuleHeaderData structure specifies information about a PivotTable rule (section 2.2.5.3.9).
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
isxvd |
|||||||||||||||||||||||||||||||
|
isxrtype |
A |
B |
C |
D |
E |
F |
G |
H |
sxaxis |
iDim |
I |
||||||||||||||||||||
|
rfxLoc (16 bytes, optional) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
isxvd (4 bytes): A signed integer that specifies the pivot field (section 2.2.5.3.2), data field (section 2.2.5.3.7.5.2), or cache field (section 2.2.5.2.2) information for this PivotTable rule.
If the record that contains this structure is in a PivotCache Definition (section 2.1.7.38) part, then isxvd MUST be -1. If isxrtype is ISXRTYPE_BUTTON, then this field is an ISXVD (section 2.5.84) that specifies the pivot field or data field and the value of this field MUST NOT be -1. If isxrtype is a value other than ISXRTYPE_BUTTON and there is no BrtBeginPRFilter record (section 2.4.179) or BrtBeginPRFilter14 record (section 2.4.180) in the collection of records following the record that contains this structure, then the value of this field MUST be -1.
If isxrtype is a value other than ISXRTYPE_BUTTON and there is at least one BrtBeginPRFilter or BrtBeginPRFilter14 record in the collection of records immediately following the record that contains this structure, then the pivot field, data field, or cache field (section 2.2.5.2.2) for this PivotTable rule is specified by the PRFilter.isxvd fields in the BrtBeginPRFilter or BrtBeginPRFilter14 records, respectively. If the record that contains this structure is a BrtBeginPRule (section 2.4.185) then the value of isxvd MUST be either -1 or the same as the value of the PRFilter.isxvd field in the last BrtBeginPRFilter record in the collection of BrtBeginPRFilter records following the record that contains this structure. If the record that contains this structure is a BrtBeginPRule14 (section 2.4.186) then the value of isxvd MUST be -1.
isxrtype (8 bits): An unsigned integer that specifies the area of the PivotTable (section 2.1.7.40) specified by this PivotTable rule. This value MUST be a value from the following table.
-
-
-
-
-
-
-
Name
Value
Description
0x00
This rule specifies no area.
0x01
This rule specifies the cells in the row area, column (1) area, page area (section 2.2.5.3.8.1.3), or data area (section 2.2.5.3.8.1.4) of the PivotTable report that correspond to the data items (section 2.2.5.3.7.5.1) or pivot items (section 2.2.5.3.3) associated with the collection of BrtBeginPRFilter or BrtBeginPRFilter14 records that immediately follow the record that contains this structure. There MUST be a collection of BrtBeginPRFilter or BrtBeginPRFilter14 records immediately following the record that contains this structure.
0x02
This rule specifies the data area (section 2.2.5.3.8.1.4) of the PivotTable report that correspond to the data items or pivot items associated with the collection of BrtBeginPRFilter or BrtBeginPRFilter14 records that immediately follow the record that contains this structure. There MUST be a collection of BrtBeginPRFilter or BrtBeginPRFilter14 records immediately following the record that contains this structure.
0x03
This rule specifies the entire PivotTable report. Collections of BrtBeginPRFilter or BrtBeginPRFilter14 records MUST NOT immediately follow the record that contains this structure.
0x04
This rule specifies the cells at the logical top-left of the PivotTable report body. Collections of BrtBeginPRFilter or BrtBeginPRFilter14 records MUST NOT immediately follow the record that contains this structure.
0x05
This rule specifies the cell on the PivotTable report containing the pivot field caption. Collections of BrtBeginPRFilter or BrtBeginPRFilter14 records MUST NOT immediately follow the record that contains this structure.
0x06
This rule specifies the cells at the logical top-right of the PivotTable report body. Collections of BrtBeginPRFilter or BrtBeginPRFilter14 records MUST NOT immediately follow the record that contains this structure.
-
-
-
-
-
-
isxrtype MUST NOT be ISXRTYPE_BUTTON or ISXRTYPE_TOPRIGHT if the record that contains this structure is a BrtBeginPRule14.
A - fDataOnly (1 bit): A bit that specifies whether only the cells in the data area are included in this PivotTable rule. fDataOnly and fLabelOnly MUST NOT both be 1. This value MUST be 1 if isxrtype is ISXRTYPE_DATA, or if the record that contains this structure is a BrtBeginPRule14.
B - fLabelOnly (1 bit): A bit that specifies whether only cells in the page area, row area or column (1) area are included in this PivotTable rule. This value MUST be 1 if isxrtype is ISXRTYPE_BUTTON or ISXRTYPE_TOPRIGHT. fDataOnly and fLabelOnly MUST NOT both be 1.
C - fGrandRw (1 bit): A bit that specifies whether cells in the grand total row are included in this PivotTable rule.
D - fGrandCol (1 bit): A bit that specifies whether cells in the grand total column (1) are included in this PivotTable rule.
E - fCacheBased (1 bit): A bit that specifies whether isxvd specifies a cache field in the PivotCache (section 2.2.5.2) or a pivot field or the data field in a PivotTable view (section 2.2.5.3).
|
Value |
Meaning |
|---|---|
|
0 |
isxvd specifies a pivot field or the data field in a PivotTable view. |
|
1 |
isxvd specifies a cache field in the PivotCache. sxaxis MUST be 0. |
This value MUST be 1 if the record that contains this structure is in a PivotCache Definition (section 2.1.7.38) part. It MUST be 0 if the record that contains this structure is a BrtBeginPRule14.
F - fLineMode (1 bit): A bit that specifies whether the area of the PivotTable report specified by this PivotTable rule is displayed in outline form (see section 2.2.5.3.7.4.2).
G - fPart (1 bit): A bit that specifies whether only a partial area of the PivotTable report is specified by this PivotTable rule. If fPart is 1, rfxLoc specifies the partial area.
H - fFuzzy (1 bit): A bit that specifies whether the pivot items of the pivot field specified by this rule are treated as subtotals for the purposes of formatting when the pivot field is displayed in outline form (see section 2.2.5.3.7.4.2).
sxaxis (4 bits): An unsigned integer that specifies the PivotTable axis (section 2.2.5.3.7) that contains the pivot field or data field specified by isxvd. This value MUST be a value from the following table.
-
-
-
-
-
Name
Value
Description
0x0
This rule specifies no axis.
0x1
This rule specifies the row axis.
0x2
This rule specifies the column (1) axis.
0x4
This rule specifies the page axis.
0x8
This rule specifies the data axis.
-
-
-
-
MUST be SXAXIS_NULL if the record that contains this structure is a BrtBeginPRule14.
iDim (8 bits): An unsigned integer that specifies the position of the pivot field or data field specified by isxvd within the PivotTable axis for the record that contains this structure.
-
If sxaxis is SXAXIS_RW, then iDim MUST be less than the number of pivot fields on the row axis.
-
If sxaxis is SXAXIS_COL, then iDim MUST be less than the number of pivot fields on the column (1) axis.
-
If sxaxis is SXAXIS_PAGE, then iDim MUST be less than the number of pivot fields on the page axis.
-
If sxaxis is SXAXIS_DATA, then iDim is undefined and MUST be ignored.
-
If sxaxis is SXAXIS_NULL, then iDim is undefined and MUST be ignored.
I - reserved (4 bits): This value MUST be 0, and MUST be ignored.
rfxLoc (16 bytes): An UncheckedRfX (section 2.5.154) that specifies the partial area within the PivotTable report specified by this PivotTable rule. The range is specified using a relative reference that specifies the offset from the logical top-left cell of the PivotTable report body as specified in PivotTable (section 2.2.5.3.8) layout. This field MUST exist only if fPart is 1.