SSGetRowHeaderCols, SSSetRowHeaderCols Functions

Applies To

fpSpread DLL control

Description

Set or return the number of columns displayed as the row header.

Syntax

SS_COORD SSGetRowHeaderCols(HWND hWnd);

void SSSetRowHeaderCols(HWND hWnd, SS_COORD lRowHeaderCols);

C++

SS_COORD TSpread::GetRowHeaderCols( );

void TSpread::SetRowHeaderCols(SS_COORD lRowHeaderCols);

Parameters

The SSGetRowHeaderCols and SSSetRowHeaderCols functions have the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpread control
lHeaderCols	Number of row header columns

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 number of header columns is 1 column. The minimum value you can set for the lHeaderCols parameter is 1. The maximum value you can set for the lHeaderCols parameter is 255.

When you set the lHeaderCols parameter to a value greater than 1, additional columns are added to the row header, as shown in the following figure, where the parameter is set to 3.

Tip: If the control displays multiple header columns such that the row headers fill the entire view of the sheet, users cannot scroll to the data portion of the sheet. Keep this in mind when sizing the control and adding multiple row header columns.

The added columns display the row header appearance: the background, text, and border colors are displayed specified by calling the SSSetShadowColor function, but the additional columns are blank by default. Call the SSSetData function to add content to the additional rows. The right-most header column displays the auto text, as specified by calling the SSSetRowHeaderDisplay function. You can have another header column display the auto text by calling the SSSetRowHeadersAutoTextIndex function.

Cell coordinates for the column and row headers are separate from cell coordinates in the content area. Column numbers in the row header are based on a constant, SS_HEADER. The first column in the row header is SS_HEADER, the second column is SS_HEADER + 1, the third column is SS_HEADER + 2, and so forth.

Note: Returned column values will use a 0 to indicate the column or row header, to provide backward compatibility with previous versions of Spread. For example, if you return the column number for the row header column by calling the SSGetColFromID function, the function returns the value 0.

Call the SSSetRowHeaderCols function to specify the number of columns used for the row header. Call the SSSetMaxCols property to specify the number of non-header columns.

This function does not have an effect unless the SSB_SHOWROWHEADERS boolean for the SSSetBool function is set to TRUE and the row header columns are not hidden.

Call the SSSetColHeaderRows function to specify the number of rows to display as the column header.

Return Value

SSGetRowHeaderCols: Number of header columns

ActiveX Correspondence

RowHeaderCols property