ColHeadersAutoTextIndex Property

Applies To

fpSpread control

Description

Sets or returns which column header row displays the auto text when there are multiple column header rows.

Syntax

C++

long CSpreadSheet::GetColHeadersAutoTextIndex( );
void CSpreadSheet::SetColHeadersAutoTextIndex(long value);

Visual Basic

[form.]fpSpread.ColHeadersAutoTextIndex[ = value&]

Remarks

The default value for the ColHeadersAutoTextIndex property is –1, which specifies to display the auto text in the bottom-most header row.

If you display multiple column header rows, use this property to specify which row displays the auto text. To specify the index, set the property to a value between 0 and n–1, where 0 is the topmost row and n is the number of header rows.

If you set the ColHeadersAutoTextIndex property to specify a row to display the auto text, for example, header row 3, and then later change the number of column header rows to be less than 3, the auto text will be displayed in the bottom-most row, as if the property is set to –1. However, if you then change the number of header rows to 3 or greater, the auto text is again displayed in header row 3.

Set the ColHeadersAutoText property to specify what auto text, if any, is displayed in the column headers. If you set the ColHeadersAutoText property to 0 (Blank), the column header row specified by the ColHeadersAutoTextIndex property will be blank. Set the ColHeaderRows property to specify how many column header rows the sheet displays.

This setting is applied to the current sheet setting unless you first set the Sheet property to specify the sheet for which you are setting the property.

This property does not have an effect unless the ColHeadersShow property is set to True and the column header that contains the auto text is not hidden.

Set the RowHeadersAutoTextIndex property to specify which row header column displays the auto text.

Spread Designer

Choose the Sheet menu, then the Headers menu, and then the General menu, select the Columns tab, and then choose or type a number in the AutoText Index spin box in the Header Settings dialog box.

Data Type

Long Integer

DLL Correspondence

SSGetColHeadersAutoTextIndex, SSSetColHeadersAutoTextIndex functions