SSInsCol, SSInsColRange Functions

Applies To

fpSpread DLL control

Description

Inserts a column or multiple columns into the sheet before the specified column.

Syntax

BOOL SSInsCol(HWND hWnd, SS_COORD Col);

BOOL SSInsColRange(HWND hWnd, SS_COORD Col, SS_COORD Col2);

C++

BOOL TSpread::InsCol(SS_COORD Col);

BOOL TSpread::InsColRange(SS_COORD Col, SS_COORD Col2);

Parameters

The following parameters are available:

Parameter	Description
hWnd	Window handle of the fpSpread control
Col	Column number of column before which to insert new column or column number of first column in range to insert if using the SSInsColRange function (Value must be greater than 0.)
Col2	Column number of last column in range to insert if using the SSInsColRange function

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 Col2 parameters, see Using Column and Row Properties.

Remarks

Use the SSInsCol function to insert a single column. Use the SSInsColRange function to insert multiple columns.

When using the SSInsColRange function, make sure that the value of the Col parameter is less than the value of the Col2 parameter.

Inserting columns beyond the last column containing data has no effect on the total number of columns.

The SSInsCol and SSInsColRange functions do not increase the number of columns set by the SSSetMaxCols function. To increase the maximum number of columns when a column or columns are inserted, use the SSSetMaxCols function to increment the maximum number of columns by the number of columns being inserted before using the SSInsCol or SSInsColRange functions.

Return Value

TRUE if the function completes successfully; FALSE otherwise.

ActiveX Correspondence

SSInsCol: InsertCols method