SSGetCellTag, SSSetCellTag Function

Applies To

fpSpread DLL control

Description

Set or return the user-defined tag for a specified cell, column, row, or the entire sheet.

Syntax

short SSGetCellTag(HWND hWnd, SS_COORD Col, SS_COORD Row, LPTSTR CellTag);

BOOL SSSetCellTag(HWND hWnd, SS_COORD Col, SS_COORD Row, LPCTSTR CellTag);

C++

short TSpread::GetCellTag(SS_COORD Col, SS_COORD Row, LPTSTR CellTag)

BOOL TSpread::SetCellTag(SS_COORD Col, SS_COORD Row, LPCTSTR CellTag)

Parameters

This function has the following parameters:

Parameter	Description
hWnd	Window handle of the fpSpread control
Col	Column number
Row	Row number
CellTag	User-defined data

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. To determine the settings you want for the Col and Row parameters, see Using Column and Row Properties.

Remarks

You can assign user-defined information to any cell, column, or row, or the entire sheet. This value is only for the application's use; the control does not use this value.

This function lets you provide information for any cell, column, or row, or the entire sheet, similar to the SSSetColUserData, SSSetRowUserData, and SSSetUserData functions, which let you assign information to a column, a row, or the sheet. The information provided by the SSSetCellTag function is stored separately from the information provided by the UserData functions. If you prefer, you can provide either or both kinds of information for the sheet, columns, and rows.

Return Value

SSGetCellTag: Returns the length of the string. You can call the SSGetCellTag function and set the CellTag parameter to NULL to determine the length of the string.
SSSetCellTag: TRUE if the function completes successfully; FALSE otherwise.

ActiveX Correspondence

CellTag property