2.4.100 BrtBeginList

The BrtBeginList record specifies the properties of a table and specifies the beginning of a collection of records as defined by the Table (section 2.1.7.51) part ABNF and the Single Cell Tables (section 2.1.7.46) part ABNF. The collection of records specifies a table.


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

rfxList (16 bytes)

...

...

lt

idList

crwHeader

crwTotals

A

B

C

D

E

reserved

nDxfHeader

nDxfData

nDxfAgg

nDxfBorder

nDxfHeaderBorder

nDxfAggBorder

dwConnID

stName (variable)

...

stDisplayName (variable)

...

stComment (variable)

...

stStyleHeader (variable)

...

stStyleData (variable)

...

stStyleAgg (variable)

...

rfxList (16 bytes): An RfX (section 2.5.118) that specifies the range of cells the table occupies. The range specified by the RfX value MUST NOT overlap with another table or AutoFilter on the same sheet. The RfX height MUST be greater than the sum of the values of the crwHeader and crwTotals fields. If fSingleCell is 1, rfxList MUST occupy exactly 1 cell.

lt (4 bytes):  A ListType (section 2.5.89) that specifies the table type.

idList (4 bytes):  An unsigned integer that specifies the numeric identifier of the table. This value MUST be unique within the containing workbook, MUST be greater than or equal to 1 and MUST be less than or equal to 4294967294 (0xFFFFFFFE).

crwHeader (4 bytes):  A Boolean (section 2.5.98.3) that specifies whether the table header row is displayed at the top of the table. The possible values for this field are listed in the following table.

Value

Meaning

0x00000000

Table header row is hidden.

0x00000001

Table header row is displayed.

crwTotals (4 bytes):  A Boolean (section 2.5.98.3) that specifies whether the table total row is displayed at the bottom of the table. The possible values for this field are listed in the following table.

Value

Meaning

0x00000000

Total row is hidden.

0x00000001

Total row is displayed.

A - fShownTotalRow (1 bit):  A bit that specifies whether the table total row has ever been displayed for this table.

B - fSingleCell (1 bit):  A bit that specifies whether the table is a single cell table. If this value equals 1, then lt MUST be equal to LTXML (section 2.5.89).

C - fForceInsertToBeVisible (1 bit):  A bit that specifies whether the table insert row is displayed.

D - fInsertRowInsCells (1 bit):  A bit that specifies whether cells in the sheet were automatically inserted when the table insert row was displayed for this table.

E - fPublished (1 bit):  A bit that specifies the publish to server state of this table.

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

nDxfHeader (4 bytes):  A DXFId (section 2.5.38) that specifies the differential formatting (section 2.2.6.2) applied to the table header row of this table. If fSingleCell is 1, the value MUST be 0xFFFFFFFF.

nDxfData (4 bytes):  A DXFId that specifies the differential formatting applied to the table data region of this table. If fSingleCell is 1, the value MUST be 0xFFFFFFFF.

nDxfAgg (4 bytes):  A DXFId that specifies the differential formatting applied to the table total row of this table. If fSingleCell is 1, the value MUST be 0xFFFFFFFF.

nDxfBorder (4 bytes):  A DXFId that specifies the differential formatting applied to the borders of the table data region of this table. If fSingleCell is 1, the value MUST be 0xFFFFFFFF.

nDxfHeaderBorder (4 bytes):  A DXFId that specifies the differential formatting applied to the borders of the table header row of this table. If fSingleCell is 1, the value MUST be 0xFFFFFFFF.

nDxfAggBorder (4 bytes):  A DXFId (section 2.5.38) that specifies the differential formatting (section 2.2.6.2) applied to the borders of the table total row of this table. If fSingleCell is 1, the value MUST be 0xFFFFFFFF.

dwConnID (4 bytes): An unsigned integer that specifies the identifier of an external connection (section 2.2.8) used by this table. The value in dwConnID MUST be 0 when the value of lt is not LTXML. The value MUST be 0 or be equal to the dwConnID value in one of the BrtBeginExtConnection (section 2.4.80) records in the BrtBeginExtConnections (section 2.4.81) collection.

stName (variable):  An XLNullableWideString (section 2.5.167) that specifies the string identifier of the table used for programmatic purposes. The string MUST be NULL or unique per Table (section 2.1.7.51) per sheet, MUST have less than or equal to 255 characters, and MUST be NULL if fSingleCell is 1. If this field is NULL, the string identifier used for programmatic purposes is specified by stDisplayName.

stDisplayName (variable):  An XLNullableWideString that specifies the string identifier of the table for use within the displayed string for formulas (section 2.2.2). The value of stDisplayName MUST have a maximum length and format specified by XLNameWideString (section 2.5.166), MUST be unique per workbook, and MUST NOT have the prefix "_xl". If fSingleCell is 1, the string MUST be NULL.

stComment (variable):  An XLNullableWideString that specifies a comment about the table. The string MUST contain less than or equal to 255 characters. If fSingleCell is 1, the string MUST be NULL.

stStyleHeader (variable):  A CellStyleName (section 2.5.11) that specifies the name of the cell style (section 2.2.6.1.2) that is applied to the table header row of the table. If fSingleCell is 1, the value MUST be a NULL string.

stStyleData (variable):  A CellStyleName that specifies the name of the cell style that is applied to the table data region of the table. If fSingleCell is 1, the value MUST be a NULL string.

stStyleAgg (variable):  A CellStyleName that specifies the name of the cell style that is applied to the table total row of the table. If fSingleCell is 1, the value MUST be a NULL string.