SSGetColID, SSSetColID Functions
Applies To
fpSpread DLL control
Description
Set or return a string for the specified column that can be used to identify the column.
Syntax
short SSGetColID(HWND hWnd, SS_COORD Col, LPTSTR ColID);
BOOL SSSetColID(HWND hWnd, SS_COORD Col, LPCTSTR ColID);
short TSpread::GetColID(SS_COORD Col, LPTSTR ColID);
BOOL TSpread::SetColID(SS_COORD Col, LPCTSTR ColID);
Parameters
The SSGetColID and SSSetColID functions have the following parameters:
| Parameter | Description |
| hWnd | Window handle of the fpSpread control |
| Col | Column number of column to name |
| ColID | Column identification string |
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 SSSetColID function lets you define a unique identification string for a column. Once you define an ID for a column, you can call the SSGetColFromID function to retrieve the column number of the column with the specified ID. You can then assign the returned value to a Col parameter to specify the column with which to interact.
| Tip: Because column numbers are based on the physical position of the column in the control, if you plan on moving columns, we strongly recommend you specify a column ID by calling the SSSetColID function for a column, and call the SSGetColFromID function to reference a column. |
Return Value
SSGetColID: Column number of the column associated with the specified ID.
SSSetColID: TRUE if the function completes successfully; FALSE otherwise.
See Also
SSGetColFromID, SSSetSheet functions
ActiveX Correspondence
ColID property