SSGetRowHeadersAutoTextIndex, SSSetRowHeadersAutoTextIndex Functions

Applies To

fpSpread DLL control

Description

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

Syntax

SS_COORD SSGetRowHeadersAutoTextIndex(HWND hWnd);

void SSSetRowHeadersAutoTextIndex(HWND hWnd, SS_COORD lRowHeadersAutoTextIndex);

C++

SS_COORD TSpread::GetRowHeadersAutoTextIndex( );

void TSpread::SetRowHeadersAutoTextIndex(SS_COORD lRowHeadersAutoTextIndex);

Parameters

The SSGetRowHeadersAutoTextIndex and SSSetRowHeadersAutoTextIndex functions have the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpread control
lRowHeadersAutoTextIndex	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 right-most header column.

If you display multiple row header columns, call this function to specify which column displays the auto text. To specify the index, set the lRowHeadersAutoTextIndex parameter to a value between 0 and n–1, where 0 is the leftmost column and n is the number of header columns.

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

Call the SSSetRowHeaderDisplay function to specify what auto text, if any, is displayed in the row headers. If you set the SSSetRowHeaderDisplay function's wDisplay paramter to SS_HEADERDISPLAY_BLANK, the row header column specified by the SSSetRowHeadersAutoTextIndex function's lRowHeadersAutoTextIndex parameter will be blank. Call the SSSetRowHeaderCols property to specify how many row header columns the control displays.

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

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

Return Value

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

ActiveX Correspondence

RowHeadersAutoTextIndex property