2.5.88 ListTotalRowFunction

The ListTotalRowFunction enumeration specifies the index of a list total aggregate (ILTA) operation to perform on the data region of a column (1) in a table.

The values ILTA_AVERAGE, ILTA_COUNT, ILTA_COUNTNUMS, ILTA_MAX, ILTA_MIN, ILTA_STDDEV, ILTA_SUM, and ILTA_VAR specify the function number and reference parameters of the subtotal formula (section 2.2.2). The function number is a 2-byte unsigned integer that specifies the aggregation operation to perform. The reference is a PtgList (section 2.5.98.52) or PtgArea (section 2.5.98.18) structure that designates the data region of the column (1) in a table.

The Parsed Expression (section 2.5.98) ABNF for the subtotal formula is as follows.

subtotal-formula = PtgInt function-number reference PtgFuncVar

reference = PtgList / PtgArea

The following non-reserved fields of PtgList MUST be equal to 0 with the following exceptions:

  • The ixti field MUST specify the Xti (section 2.5.173) structure that identifies the sheet that contains the table.

  • The columns field MUST equal 0x01.

  • The listIndex field MUST equal the associated idList field of the BrtBeginList (section 2.4.100) record.

  • The colFirst field MUST equal the zero-based index of the table column (1) within the BrtBeginList record.

  • The colLast field MUST be equal to the colFirst field.

The following non-reserved fields of PtgArea MUST have the following values:

  • The rowFirst field MUST equal the first sheet row of the data region of the table column (1).

  • The rowLast field MUST equal the last sheet row of the data region of the table column (1).

  • The columnFirst field MUST equal the sheet column (1) of the data region of the table column (1).

  • The columnLast field MUST equal columnFirst.

  • The type, columnFirst, rowFirst, columnLast, and rowLast fields MUST equal 0x01.

The following non-reserved fields of the PtgFuncVar (section 2.5.98.46) structure MUST equal 0, with the following exceptions:

  • The type field MUST equal 0x02.

  • The cparams field MUST equal 0x02.

  • The tab field MUST equal 0x0158.

  • The fCeFunc field MUST equal 0x00.

The following table specifies the values of this enumeration and the value and meaning of the function number.

Name

Value

Meaning

ILTA_NONE

0x00000000

Specifies that no operation is performed.

ILTA_AVERAGE

0x00000001

Specifies to calculate the arithmetic mean. The function number of the subtotal formula is 101.

ILTA_COUNT

0x00000002

Specifies to count the non-empty cells. The function number of the subtotal formula is 103.

ILTA_COUNTNUMS

0x00000003

Specifies to count the cells that contain numbers. The function number of the subtotal formula is 102.

ILTA_MAX

0x00000004

Specifies to calculate the largest value. The function number of the subtotal formula is 104.

ILTA_MIN

0x00000005

Specifies to calculate the smallest value. The function number of the subtotal formula is 105.

ILTA_SUM

0x00000006

Specifies to calculate the arithmetic sum. The function number of the subtotal formula is 109.

ILTA_STDDEV

0x00000007

Specifies to calculate the estimated standard deviation. The function number of the subtotal formula is 107.

ILTA_VAR

0x00000008

Specifies to calculate the estimated variance. The function number of the subtotal formula is 110.

ILTA_CUSTOM

0x00000009

Specifies to use the formula specified by the BrtListTrFmla (section 2.4.701) child record of the BrtBeginListCol (section 2.4.101) record.