2.4.273.99 SXAddl_SXCSXrule_SXDSXrule

The SXAddl_SXCSXrule_SXDSXrule record specifies information for a PivotTable rule, for an SXCSXrule class.


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

hdr

...

reserved1

...

A

sxrtype

B

C

D

E

F

G

H

I

J

reserved4

K

L

M

N

O

P

reserved6

irwFirst

irwLast

icolFirst

icolLast

csxfilt

...

iDim

...

isxvd

...

hdr (6 bytes): An SXAddlHdr structure. The value of hdr.sxc MUST equal 0x0C and the value of hdr.sxd MUST equal 0x13.

reserved1 (6 bytes): MUST be zero, and MUST be ignored.

A - reserved2 (4 bits): MUST be zero, and MUST be ignored.

sxrtype (4 bits):  An unsigned integer that specifies the area of the PivotTable specified by this PivotTable rule. MUST be a value from the following table:

Value

Meaning

0x0

This rule applies to no area.

0x1

This rule applies to selected cells in the row area, column area, or data area of the PivotTable report.

0x2

This rule applies to the data area of the PivotTable report.

0x3

This rule applies to the entire PivotTable report.

0x4

This rule applies to the blank cells at the logical top-left of the PivotTable report.

0x5

This rule applies to a button shown next to a pivot field in the PivotTable report.

0x6

This rule applies to the blank cells at the logical top-right of the PivotTable report.

If the value of isxvd is not -1, MUST be 0x1 or 0x2 or 0x5.

B - fPart (1 bit):  A bit that specifies whether only a portion of the PivotTable area is included in this rule. MUST be a value from the following table:

Value

Meaning

0x0

The entire PivotTable area is included in the rule. The irwFirst, irwLast, icolFirst, and icolLast fields are undefined and MUST be ignored.

0x1

A portion of the PivotTable area is included in the rule. The irwFirst, irwLast, icolFirst, and icolLast fields hold the relative offset into the PivotTable area included in this rule.

C - fDataOnly (1 bit):  A bit that specifies whether only the cells in the data area are included in this PivotTable rule. If fLabelOnly is 1 then fDataOnly MUST be 0. If sxrtype is 0x2, the value of this field value MUST be 1.

D - fLabelOnly (1 bit):  A bit that specifies whether only cells in the page area, row area, or column area are included in this PivotTable rule. If fDataOnly is 1 then fLabelOnly MUST be 0. If sxrtype is 0x5 or 0x6, this value MUST be 1.

E - fGrandRw (1 bit):  A bit that specifies whether cells in the grand total row are included in this PivotTable rule.

F - fGrandCol (1 bit):  A bit that specifies whether cells in the grand total column are included in this PivotTable rule.

G - fGrandRwSav (1 bit):  A bit that specifies whether cells in the grand total row are included in this PivotTable rule. MUST be equal to fGrandRw.

H - reserved3 (1 bit):  MUST be zero, and MUST be ignored.

I - fGrandColSav (1 bit):  A bit that specifies whether cells in the grand total column are included in this PivotTable rule. MUST be equal to fGrandCol.

J - 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 mode.

reserved4 (15 bits): MUST be zero, and MUST be ignored.

K - unused1 (1 bit): Undefined, MUST be ignored.

L - fLineMode (1 bit):  A bit that specifies whether the area of the PivotTable report specified by this PivotTable rule is displayed in outline mode.

M - unused2 (1 bit): Undefined, MUST be ignored.

N - unused3 (1 bit): Undefined, MUST be ignored.

O - reserved5 (1 bit): MUST be zero, and MUST be ignored.

P - fDrillOnly (1 bit): A bit that specifies the sort order of the PivotTable rule filters specified by csxfilt. MUST be a value from the following table:

Value

Meaning

0x0

PivotTable rule filters  are sorted by Pivot Field index as specified in Pivot Fields.

0x1

PivotTable rule filters are sorted by position.

reserved6 (10 bits): MUST be zero, and MUST be ignored.

irwFirst (1 byte):  A DRwByteU structure that specifies the difference between the index of the first row of the range of cells included in this rule and the index of the first row of the PivotTable.

irwLast (1 byte): A DRwByteU structure that specifies the difference between the index of the last row of the range of cells included in this rule and the index of the first row of the PivotTable. If fPart is 1, MUST be greater than or equal to irwFirst.

icolFirst (1 byte):  A DColByteU structure that specifies the difference between the index of the first column of the range of cells included in this rule and the index of the first column of the PivotTable.

icolLast (1 byte):  A DColByteU structure that specifies the difference between the index of the last column of the range of cells included in this rule and the index of the first column of the PivotTable. If fPart is 1, MUST be greater than or equal to icolFirst.

csxfilt (4 bytes): An unsigned integer that specifies the number of SXAddl_SXCSXfilt_SXDId records following this record. MUST be greater than or equal to 0. If sxrtype is not 0x1 or 0x2, this value MUST be 0.

iDim (4 bytes):  An signed integer that specifies the position of the pivot field within the PivotTable axis for this PivotTable rule. If isxvd is 0xFFFFFFFE or 0xFFFFFFFF this field MUST be ignored. If isxvd is between 0x00000000 and 0x000000FF, then the value of iDim depends on the value of certain fields in the sxaxis structure in isxvd. The following table shows the values that iDim MUST have given certain values of the specified fields of isxvd.sxaxis.

 Value

Meaning

isxvd.sxaxis.sxaxisRw is 1

The value of iDim MUST be greater than 0 and less than the number of pivot fields on the row axis.

isxvd.sxaxis.sxaxisCol is 1

The value of iDim MUST be greater than 0 and less than the number of pivot fields on the column axis.

isxvd.sxaxis.sxaxisPage is 1

The value of iDim MUST be greater than 0 and less than the number of pivot fields on the page axis.

isxvd.sxaxis.sxaxisData is 1

The value of iDim MUST be greater than 0 and less than the number of pivot fields on the data axis

isxvd (4 bytes):  A signed integer that specifies the pivot field this rule refers to. MUST be a value from the following table:

Value

Meaning

0xFFFFFFFE

This rule refers to the data field.

0xFFFFFFFF

This rule does not refer to a pivot field.

0x0000000 to 0x000000FF

This value specifies a pivot field index as specified in Pivot Fields. The pivot field index specifies which pivot field this rule refers to.

MUST be greater than or equal to 0xFFFFFFFE and less than or equal to 0x000000FF. If the value is greater than or equal to 0x00000000, MUST be less than the value of the  cDim field of the preceding SxView.