SSAddCustomCellType Function

Applies To

fpSpread DLL control

Description

Adds a custom cell to the Spread control.

Syntax

BOOL SSAddCustomCellType(HWND hWnd, LPCTSTR Name, BOOL bEditable, BOOL bCanOverflow, BOOL bCanBeOverflown, BOOL bUseRendererControl, LPSS_CT_PROCS lpProcs);

C++

BOOL TSpread::AddCustomCellType( LPCTSTR Name, BOOL bEditable, BOOL bCanOverflow, BOOL bCanBeOverflown, BOOL bUseRendererControl, LPSS_CT_PROCS lpProcs);

Parameters

The following parameters are available:

Parameter	Description
hWnd	Window handle of the fpSpread control
Name	String that defines the function name
bEditable	Whether the cell is editable
bCanOverflow	Whether the cell can overflow into the next cell(s)
bCanBeOverflown	Whether the cell can have values overflow into it
bUseRendererControl	Whether to use a control renderer
lpProcs	Structure that contains all the call back functions for a custom cell

Remarks

The SS_CT_PROCS structure lists the interface of the call back functions for the custom cell type. The call back functions consists of editor, renderer, and formatter methods.

The call back functions for the editor methods have the following syntax:

BOOL CALLBACK SS_CT_CREATEEDITORCONTROLFUNC(LPSS_CT_CREATEEDITORCONTROL_ARGS lpArgs);
BOOL CALLBACK SS_CT_CREATEDRENDERERCONTROLFUNC(LPSS_CT_CREATERENDERERCONTROL_ARGS lpArgs);
BOOL CALLBACK SS_CT_INITIALIZECONTROLFUNC(LPSS_CT_INITIALIZECONTROL_ARGS lpArgs);
BOOL CALLBACK SS_CT_GETEDITORVALUEFUNC(LPSS_CT_GETEDITORVALUE_ARGS lpArgs);
BOOL CALLBACK SS_CT_SETVALUEFUNC(LPSS_CT_SETVALUE_ARGS lpArgs);
BOOL CALLBACK SS_CT_STARTEDITINGFUNC(LPSS_CT_STARTEDITING_ARGS lpArgs);
BOOL CALLBACK SS_CT_CANCELEDITINGFUNC(LPSS_CT_CANCELEDITING_ARGS lpArgs);
BOOL CALLBACK SS_CT_STOPEDITINGFUNC(LPSS_CT_STOPEDITING_ARGS lpArgs);
BOOL CALLBACK SS_CT_ISRESERVEDKEYFUNC(LPSS_CT_ISRESERVEDKEY_ARGS lpArgs);
BOOL CALLBACK SS_CT_ISRESERVEDLOCATIONFUNC(LPSS_CT_ISRESERVEDLOCATION_ARGS lpArgs);
BOOL CALLBACK SS_CT_ISVALIDFUNC(LPSS_CT_ISVALID_ARGS lpArgs);
BOOL CALLBACK SS_CT_GETRESERVEDCURSORFUNC(LPSS_CT_GETRESERVEDCURSOR_ARGS lpArgs);

The call back functions for the renderer methods have the following syntax:

BOOL CALLBACK SS_CT_GETPREFERREDSIZEFUNC(LPSS_CT_GETPREFERREDSIZE_ARGS lpArgs);
BOOL CALLBACK SS_CT_PAINTCELLFUNC(LPSS_CT_PAINTCELL_ARGS lpArgs);

The call back functions for the formatter methods have the following syntax:

BOOL CALLBACK SS_CT_STRINGFORMATFUNC(LPSS_CT_STRINGFORMAT_ARGS lpArgs);
BOOL CALLBACK SS_CT_STRINGUNFORMATFUNC(LPSS_CT_STRINGUNFORMAT_ARGS lpArgs);

Return Value

TRUE if the function completes successfully; FALSE otherwise.

ActiveX Correspondence

AddCustomCellType method