Spread 8.0 Documentation
SSGetRowHeaderDisplay, SSSetRowHeaderDisplay Functions
Support Options
DLL Reference > DLL Functions > SSGetRowHeaderDisplay, SSSetRowHeaderDisplay Functions

Glossary Item Box

SSGetRowHeaderDisplay, SSSetRowHeaderDisplay Functions


See Also    ActiveX

Applies To

fpSpread DLL control

Description

Set or return whether the row header displays letters, numbers, or is blank.

Syntax

C

WORD SSGetRowHeaderDisplay(HWND hWnd);

WORD SSSetRowHeaderDisplay(HWND hWnd, WORD wDisplay);

C++

WORD TSpread::GetRowHeaderDisplay( );

WORD TSpread::SetRowHeaderDisplay(WORD wDisplay);

Parameters

The SSGetRowHeaderDisplay function has the following parameter:

Parameter Description
hWnd Window handle of the fpSpread control

The SSSetRowHeaderDisplay function has the following parameters:

Parameter Description
hWnd Window handle of the fpSpread control
wDisplay Numbering style
Use one of the following values:
Constant Description
SS_HEADERDISPLAY_BLANK Displays blanks
SS_HEADERDISPLAY_NUMBERS Displays the row headers as numbers
SS_HEADERDISPLAY_LETTERS Displays the row headers as letters

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.

By default, the row header is displayed as numbers; however, the row header cells can be blank or display letters. Use the SSSetRowHeaderDisplay function to specify the numbering style of the row header.

Notes:
  • Use the SSSetRowHeaderDisplay function with row header cells that do not contain data. If you place data into a row header cell using the SSSetData or SSSetValue functions, the value of the SSSetData or SSSetValue function overrides any previously applied SSSetRowHeaderDisplay function setting.
  • The SSGetData and SSGetValue functions do not return the text in a column or row header cell unless the cell contains data (custom text). The functions do not return the auto text in the header cells.

If your control displays multiple row header columns, call the SSSetRowHeadersAutoTextIndex function to specify which row header column contains the auto text.

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.

Use the SSSetColHeaderDisplay function to specify the numbering style of the column header.

Return Value

Previous value (refer to the wDisplay parameter for an explanation of the available return values).

See Also

Specifying Header Content Type

SSGetColHeaderDisplay, SSGetRowHeadersAutoTextIndex, SSSetColHeaderDisplay, SSSetRowHeadersAutoTextIndex, SSSetSheet functions

ActiveX Correspondence

RowHeadersAutoText property

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.