SSGetColHeadersAutoTextIndex, SSSetColHeadersAutoTextIndex Functions

Applies To

fpSpread DLL control

Description

Set or return which column header row displays the auto text when there are multiple column header rows.

Syntax

SS_COORD SSGetColHeadersAutoTextIndex(HWND hWnd);

void SSSetColHeadersAutoTextIndex(HWND hWnd, SS_COORD lColHeadersAutoTextIndex);

C++

SS_COORD TSpread::GetColHeadersAutoTextIndex( );

void TSpread::SetColHeadersAutoTextIndex(SS_COORD lColHeadersAutoTextIndex);

Parameters

The SSGetColHeadersAutoTextIndex and SSSetColHeadersAutoTextIndex functions have the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpread control
lColHeadersAutoTextIndex	Index of header to display the automatically supplied header text

Remarks

This function is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet for which you are calling this function.

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

If you display multiple column header rows, call this function to specify which row displays the auto text. To specify the index, set the lColHeadersAutoTextIndex parameter 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 lColHeadersAutoTextIndex parameter 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 parameter 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.

Call the SSSetColHeaderDisplay function to specify what auto text, if any, is displayed in the column headers. If you set the SSSetColHeaderDisplay function's wDisplay parameter to SS_HEADERDISPLAY_BLANK, the column header row specified by the SSSetColHeadersAutoTextIndex function's lColHeadersAutoTextIndex parameter will be blank. Call the SSSetColHeaderRows function to specify how many column header rows the control displays.

This function does not have an effect unless the SSB_SHOWCOLHEADERS boolean for the SSSetBool function is set to TRUE and the column header that contains the auto text is not hidden.

Call the SSSetRowHeadersAutoTextIndex function to specify which row header column displays the auto text.

Return Value

SSGetColHeadersAutoTextIndex: Index of header that displays the automatically supplied header text or –1

ActiveX Correspondence

ColHeadersAutoTextIndex property