2.4.275 BrtBeginSXView

The BrtBeginSXView record specifies PivotTable view (section 2.2.5.3) properties and specifies the beginning of a collection of records as defined in the PivotTable (section 2.1.7.40) part ABNF. The collection of records specifies a PivotTable view.


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

bVerSxMacro

A

B

C

D

E

F

G

H

I

J

K

L

M

N

cIndentInc

O

P

Q

R

S

T

U

V

W

X

Y

Z

a

b

c

d

e

f

g

h

i

j

k

l

m

n

o

p

q

r

s

t

u

v

w

x

y

z

α

β

γ

δ

ε

ζ

η

θ

ι

κ

reserved5

sxaxis4Data

cWrapPage

bVerSxLastUpdated

bVerSxUpdateableMin

ipos4Data

itblAutoFmt

reserved6

dwCrtFmtId

idCache

irstName (variable)

...

irstData (variable)

...

irstGrand (variable)

...

irstErrorString (variable)

...

irstNullString (variable)

...

irstPageFieldStyle (variable)

...

irstTableStyle (variable)

...

irstVacateStyle (variable)

...

irstTag (variable)

...

irstColHdrName (variable)

...

irstRwHdrName (variable)

...

bVerSxMacro (1 byte):  A DataFunctionalityLevel (section 2.5.29) that specifies the data functionality level (section 2.2.5.1) that this PivotTable view was created with.

A - fDisplayImmediateItems (1 bit): A bit that specifies whether pivot item (section 2.2.5.3.3) labels will be displayed in the row area and the column (1) area when there are no data items (section 2.2.5.3.7.5.1) in the PivotTable view.

B - fEnableDataEd (1 bit): A bit that specifies whether cells displaying values for data items can be edited.

C - fDisableFList (1 bit): A bit that specifies whether the pivot field (section 2.2.5.3.2) list, a mechanism for adding and removing pivot fields from the PivotTable view, will not be displayed.

D - fReenterOnLoadOnce (1 bit): A bit that specifies whether the PivotTable view will be automatically updated on load.

E - fNotViewCalculatedMembers (1 bit): A bit that specifies whether OLAP calculated members will not be displayed in the PivotTable view. This value MUST be ignored for non-OLAP PivotTables.

F - fNotVisualTotals (1 bit): A bit that specifies whether hidden pivot items (section 2.2.5.3.3) will be included when calculating totals. This value MUST be ignored for non-OLAP PivotTable views.

G - fPageMultipleItemLabel (1 bit): A bit that specifies whether a pivot field on the page axis (section 2.2.5.3.7.1) with multiple pivot items selected displays "(multiple items)" instead of "All". This value MUST be ignored for OLAP PivotTable views.

H - reserved1 (1 bit): This value MUST be 0 and MUST be ignored.

I - fHideDDData (1 bit): A bit that specifies whether a drop-down button, a mechanism for removing data items from the PivotTable view, for the data field (section 2.2.5.3.7.5.2) in the PivotTable view is hidden.

J - reserved2 (3 bits): This value MUST be 0 and MUST be ignored.

K - fHideDrillIndicators (1 bit): A bit that specifies whether expand/collapse buttons are hidden.

L - fPrintDrillIndicators (1 bit): A bit that specifies whether expand/collapse buttons are printed.

M - fMemPropsInTips (1 bit): A bit that specifies whether member property information is shown in PivotTable view ToolTips.

N - fNoPivotTips (1 bit): A bit that specifies whether ToolTips are not displayed for cells associated with the PivotTable view.

cIndentInc (7 bits): An unsigned integer that specifies the indentation increment that is used for pivot fields in compact axis mode. The increment is one space greater than the number specified by this field. A value of 127 specifies that indentation is not used. For more details, see section 2.2.5.3.8.3.

O - fNoHeaders (1 bit): A bit that specifies whether data field captions and pivot field captions on the row axis and the column (1) axis in the PivotTable view are not displayed.

P - fNoStencil (1 bit): A bit that specifies how drop zones are displayed in the PivotTable view. This value MUST be a value from the following table.

Value

Meaning

0

Large drop zones are displayed when there are no data items in the PivotTable view. Small drop zones are not displayed.

1

Small drop zones are displayed. Large drop zones are not displayed.

Q - fHideTotAnnotation (1 bit): A bit that specifies whether an asterisk is not displayed next to the caption for subtotals and grand totals when the fNotVisualTotals field is equal to 1. This value MUST be ignored for non-OLAP PivotTable view.

R - fIncludeEmptyRw (1 bit): A bit that specifies whether to include rows with no data in the source data (section 2.2.5.2.1) in the PivotTable view. This value MUST be ignored for non-OLAP PivotTable view.

S - fIncludeEmptyCol (1 bit): A bit that specifies whether to include columns (1) with no data in the source data in the PivotTable view. This value MUST be ignored for non-OLAP PivotTable view.

T - fEnableWizard (1 bit):  A bit that specifies whether the PivotTable wizard is available.

U - fEnableDrilldown (1 bit): A bit that specifies whether details can be shown for a cell that displays the value for a data item.

V - fEnableFieldDialog (1 bit): A bit that specifies whether pivot field properties can be displayed.

W - fPreserveFormatting (1 bit): A bit that specifies whether formatting applied by the user to PivotTable view cells is preserved on refresh.

X - fAutoFormat (1 bit): A bit that specifies whether an AutoFormat has been applied to the PivotTable view.

Y - fDisplayErrorString (1 bit): A bit that specifies what is displayed in cells that contain values for data items when an error occurs. This value MUST be a value from the following table.

Value

Meaning

0

If there are errors, error strings to display in the cells are determined by the application.

1

If there are errors, the string as specified by the irstErrorString field is displayed in the cells.

Z - fDisplayNullString (1 bit): A bit that specifies what is displayed in cells that contain values for data items that are empty. This value MUST be a value from the following table.

Value

Meaning

0

If a cell is empty, nothing is displayed.

1

If a cell is empty, the string as specified by the irstNullString field is displayed in the cell.

a - fAcrossPageLay (1 bit): A bit that specifies how pivot fields are laid out in the sheet when there are multiple pivot fields on the page axis. This value MUST be equal to one of the following.

Value

Meaning

0

Pivot fields will be displayed down, then over.

1

Pivot fields will be displayed over, then down.

b - fSubtotalHiddenPageItems (1 bit): A bit that specifies page-filtering behavior. See section 2.2.5.3.7.1.1 for details.

If this is an OLAP PivotTable view, this value SHOULD<24> be equal to 1. If this is not an OLAP PivotTable view and the bVerSxMacro field is greater than or equal to 3, this value MUST be equal to 0.

c - fRwGrand (1 bit): A bit that specifies whether grand totals are displayed for the column (1) axis.

d - fColGrand (1 bit): A bit that specifies whether grand totals are displayed for the row axis.

e - fPrintTitles (1 bit): A bit that specifies whether print titles are set to parts of the row area and column (1) area when the PivotTable view is recalculated.

f - unused (1 bit): This value is undefined and MUST be ignored.

g - fRepeatItemsOnEachPrintedPage (1 bit): A bit that specifies whether pivot item captions on the row area are repeated on each printed page for pivot fields in tabular form.

h - fMergeLabels (1 bit): A bit that specifies whether pivot item captions on the row area and column (1) area that span multiple cells are merged into a single cell.

i - fDisplayData (1 bit): A bit that specifies whether there is an irstData field after the fixed part of this record. This value MUST be equal to 1.

j - fDisplayGrand (1 bit): A bit that specifies whether there is an irstGrand field after the fixed part of this record.

k - fDisplayPageFieldStyle (1 bit): A bit that specifies whether there is an irstPageFieldStyle field after the fixed part of this record.

l - fDisplayTableStyle (1 bit): A bit that specifies whether there is an irstTableStyle field after the fixed part of this record.

m - fDisplayVacateStyle (1 bit): A bit that specifies whether there is an irstVacateStyle field after the fixed part of this record.

n - ibitAtrNum (1 bit): A bit that specifies whether AutoFormat number format properties are applied.

o - ibitAtrFnt (1 bit): A bit that specifies whether AutoFormat font format properties are applied.

p - ibitAtrAlc (1 bit): A bit that specifies whether AutoFormat alignment format properties are applied.

q - ibitAtrBdr (1 bit): A bit that specifies whether AutoFormat border format properties are applied.

r - ibitAtrPat (1 bit): A bit that specifies whether AutoFormat pattern format properties are applied.

s - ibitAtrProt (1 bit):  A bit that specifies whether the AutoFormat style is protected.

t - fDisplayTag (1 bit): A bit that specifies whether there is an irstTag field after the fixed part of this record.

u - reserved3 (1 bit): This value MUST be 0, and MUST be ignored.

v - fDefaultCompact (1 bit): A bit that specifies whether new pivot fields are created in compact axis mode. For more details, see section 2.2.5.3.8.3.

w - fDefaultOutline (1 bit): A bit that specifies whether new pivot fields are created in outline form. For more information, see section 2.2.5.3.7.4.2.

x - fOutlineData (1 bit): A bit that specifies whether the data field in the PivotTable view is displayed in outline form. For more details, see Subtotaling (section 2.2.5.3.7.4.2).

y - fCompactData (1 bit):  A bit that specifies whether the data field in the PivotTable view is displayed in compact axis mode. For more details, see section 2.2.5.3.8.3.

z - fNewDropZones (1 bit): A bit that specifies whether in-grid drop zones are disabled.

α - fPublished (1 bit): A bit that specifies whether this PivotTable view is included in the version of the workbook that is published to or rendered on a Web or application server.

β - fEmptyDisplayErrorString (1 bit): A bit that specifies whether the irstErrorString field does not exist after the fixed part of this record.

γ - fEmptyDisplayNullString (1 bit): A bit that specifies whether the irstNullString field does not exist after the fixed part of this record.

δ - fTurnOffImmersive (1 bit): A bit that specifies whether the PivotTable contextual tab, a user interface for manipulating PivotTable options, is not displayed.

ε - fSingleFilterPerField (1 bit): A bit that specifies whether the pivot fields in the PivotTable view each can have only one filter. For more details, see section 2.2.5.3.5 and section 2.2.5.3.6.1. This value MUST be a value from the following table.

Value

Meaning

0

Each pivot field can have multiple filters applied to it.

1

Each pivot field can have only one filter applied to it.

ζ - fUseRwHdrName (1 bit): A bit that specifies whether there is an irstRwHdrName field after the fixed part of this record.

η - fUseColHdrName (1 bit): A bit that specifies whether there is an irstColHdrName field after the fixed part of this record.

θ - fNonDefaultSortInFlist (1 bit): A bit that specifies how pivot fields in this PivotTable are sorted in the pivot field list, a mechanism for adding and removing pivot fields from the PivotTable view. This value MUST be a value from the following table.

Value

Meaning

0

Pivot fields are displayed in source data order.

1

Pivot fields are displayed in ascending alphabetical order.

ι - reserved4 (1 bit): This value MUST be 0, and MUST be ignored.

κ - fDontUseCustomLists (1 bit): A bit that specifies whether custom lists are not used when sorting the pivot items in the PivotTable view.

reserved5 (17 bits): This value MUST be 0, and MUST be ignored.

sxaxis4Data (1 byte): An unsigned integer that specifies which PivotTable axis (section 2.2.5.3.7) the data field appears on. MUST be one of the following values:

Value

Meaning

0x01

The data field appears on the row axis.

0x02

The data field appears on the column (1) axis.

cWrapPage (1 byte): An unsigned integer that specifies the number of pivot fields on the page axis to display before starting another row or column (1), as specified by the fAcrossPageLay field. A value of 0 specifies that no wrapping will occur.

bVerSxLastUpdated (1 byte):  A DataFunctionalityLevel that specifies the data functionality level that this PivotTable view was last updated with.

bVerSxUpdateableMin (1 byte):  A DataFunctionalityLevel that specifies the lowest data functionality level the application is allowed to update this PivotTable view with.

ipos4Data (4 bytes): A signed integer that specifies the default position of the data field on the PivotTable axis (section 2.2.5.3.7) specified by sxaxis4Data. A value of -1 specifies that the data field appears as the last field on the axis. All other values specify a specific zero-based position on that axis. This value MUST be greater than or equal to -1.

itblAutoFmt (2 bytes): An AutoFormatID (section 2.5.4) that specifies which AutoFormat will be applied.

reserved6 (2 bytes): This value MUST be 0, and MUST be ignored.

dwCrtFmtId (4 bytes): An unsigned integer that specifies the next available chart identifier to use when creating a PivotChart (section 2.2.3.2) for this PivotTable.

idCache (4 bytes): An unsigned integer that specifies the PivotCache (section 2.2.5.2) identifier of the PivotCache used by this PivotTable view. This value MUST be equal to the idSx field of a BrtBeginPivotCacheID (section 2.4.169) record. For more details, see section 2.2.5.3.1.

irstName (variable): An XLWideString (section 2.5.169) that specifies the unique name for this PivotTable view. This string MUST be less than or equal to 255 characters in length. This string MUST NOT equal the irstName field on any other PivotTable view that exists on the same sheet.

irstData (variable): An XLWideString that specifies the caption of the data field in the PivotTable view. This caption is shown when the PivotTable view has two or more data items. If fDisplayData is equal to 1, this field MUST be present in this record. If fDisplayData is equal to 0, this field MUST NOT be present in this record. This string MUST be less than or equal to 255 characters in length.

irstGrand (variable): An XLWideString that specifies a user-defined caption to display for grand totals when the PivotTable is recalculated. This string MUST be less than or equal to 255 characters in length. If the fDisplayGrand field is equal to 1, this field MUST be present in this record. If fDisplayGrand is equal to 0, this field MUST NOT be present in this record.

irstErrorString (variable): An XLWideString that specifies the string to display in cells that contain values for data items when an error occurs. This string MUST be less than or equal to 255 characters in length. If fEmptyDisplayErrorString is equal to 0, this field MUST be present in this record. If fEmptyDisplayErrorString is equal to 1, this field MUST NOT be present in this record.

irstNullString (variable): An XLWideString that specifies the string to display in cells that contain values for data items that are empty. This string MUST be less than or equal to 255 characters in length. If fEmptyDisplayNullString is equal to 0, this field MUST be present in this record. If fEmptyDisplayNullString is equal to 1, this field MUST NOT be present in this record.

irstPageFieldStyle (variable): An XLWideString that specifies the cell style (section 2.2.6.1.2) to apply to each cell that contains data for pivot fields on the page axis of the PivotTable view. The style is specified by the BrtStyle (section 2.4.798) record that has an stName field equal to the value of this field. If fDisplayPageFieldStyle is 1, this field MUST be present in this record. If fDisplayPageFieldStyle is 0, this field MUST NOT be present in this record. This string MUST be less than or equal to 255 characters in length.

irstTableStyle (variable): A XLWideString that specifies the cell style to apply to this PivotTable view. The style is specified by the BrtStyle record that has an stName field equal to the value of this field. For more details, see section 2.2.6. If fDisplayTableStyle is equal to 1, this field MUST be present in the record. If fDisplayTableStyle is equal to 0, this field MUST NOT be present in the record.

irstVacateStyle (variable):  An XLWideString that specifies the cell style to apply to the cells left blank when a PivotTable view shrinks during a refresh operation. The style is specified by the BrtStyle record that has an stName field equal to the value of this field. If fDisplayVacateStyle is equal to 1, this field MUST be present in the record. If fDisplayVacateStyle is equal to 0, this field MUST NOT be present in the record. This string MUST be less than or equal to 255 characters in length.

irstTag (variable): An XLWideString that specifies a user-defined string that is associated with this PivotTable view. This string MUST be less than or equal to 255 characters in length. If fDisplayTag is equal to 1, this field MUST be present in the record. If fDisplayTag is equal to 0, this field MUST NOT be present in the record.

irstColHdrName (variable): An XLWideString that specifies the user-defined string to display in the column (1) header when one or more pivot fields in the PivotTable view are in compact axis mode. If this field is not present, an application specific string is used in the column (1) header. For more details, see section 2.2.5.3.8.3.

If fUseRwHdrName is equal to 1, this field MUST be present in the record. If fUseRwHdrName is equal to 0, this field MUST NOT be present in the record. If bVerSxMacro is less than 3, this string MUST be less than or equal to 255 characters in length. If bVerSxMacro is greater than or equal to 3, this string MUST be less than or equal to 32,767 characters in length.

irstRwHdrName (variable): An XLWideString that specifies the user-defined string to display in the row header when one or more pivot fields in the PivotTable view are in compact axis mode. If this field is not present, an application-specific string is used in the row header. For more details, see section 2.2.5.3.8.3.

If fUseRwHdrName is equal to 1, this field MUST be present in the record. If fUseRwHdrName is equal to 0, this field MUST NOT be present in the record. If bVerSxMacro is less than 3, this string MUST be less than or equal to 255 characters in length. If bVerSxMacro is greater than or equal to 3, this string MUST be less than or equal to 32,767 characters in length.