EventEnabled Property

Applies To

fpSpread control

Description

Sets or returns whether a specified event is enabled. This property is available at run time only.

Syntax

C++

BOOL CSpreadSheet::GetEventEnabled(long Event);
void CSpreadSheet::SetEventEnabled(long Event, BOOL bNewValue);

Visual Basic

[form.]fpSpread.EventEnabled(Event As short)[ = boolean%]

Remarks

The default value for the EventEnabled property is True for all ActiveX control events except for the QueryData event.

This setting is applied to the current sheet setting unless you first set the Sheet property to specify the sheet for which you are setting the property.

Specify the event that you are enabling or disabling using the Event parameter. Use the following values to designate the event:

Event name	Index value	Constant
All events	0	EventAllEvents
Advance	1	EventAdvance
AfterUserSort	2	EventAfterUserSort
BeforeUserSort	3	EventBeforeUserSort
BlockSelected	4	EventBlockSelected
ButtonClicked	5	EventButtonClicked
Change	6	EventChange
Click	7	EventClick
ColWidthChange	8	EventColWidthChange
ComboCloseUp	9	EventComboCloseUp
ComboDropDown	10	EventComboDropDown
ComboSelChange	11	EventComboSelChange
CustomFunction	12	EventCustomFunction
DataColConfig	13	EventDataColConfig
DataFill	14	EventDataFill
DblClick	15	EventDblClick
DragDropBlock	16	EventDragDropBlock
DrawItem	17	EventDrawItem
EditChange	18	EventEditChange
EditError	19	EventEditError
EditMode	20	EventEditMode
EnterRow	21	EventEnterRow
KeyDown	22	EventKeyDown
KeyPress	23	EventKeyPress
KeyUp	24	EventKeyUp
LeaveCell	25	EventLeaveCell
LeaveRow	26	EventLeaveRow
OLECompleteDrag	27	EventOLECompleteDrag
OLEDragDrop	28	EventOLEDragDrop
OLEDragOver	29	EventOLEDragOver
OLEGiveFeedback	30	EventOLEGiveFeedback
OLESetData	31	EventOLESetData
OLEStartDrag	32	EventOLEStartDrag
PrintAbort	33	EventPrintAbort
PrintMsgBox	34	EventPrintMsgBox
QueryAdvance	35	EventQueryAdvance
QueryData	36	EventQueryData
RightClick	37	EventRightClick
RowHeightChange	38	EventRowHeightChange
SelChange	39	EventSelChange
TextTipFetch	40	EventTextTipFetch
TopLeftChange	41	EventTopLeftChange
UserFormulaEntered	42	EventUserFormulaEntered
VirtualClearData	43	EventVirtualClearData
SheetChanging	44	EventSheetChanging
SheetChanged	45	EventSheetChanged
TabScrolling	46	EventTabScrolling
TabScrolled	47	EventTabScrolled
BeforeEditMode	48	EventBeforeEditMode
DataLoaded	49	EventDataLoaded
BeforeScrollTip	50	EventBeforeScrollTip
BeforeColMove	51	EventBeforeColMove
BeforeRowMove	52	EventBeforeRowMove
CircularFormula	53	EventCircularFormula
CTCancelEditing	54	EventCTCancelEditing
CTCreateEditorControl	55	EventCTCreateEditorControl
CTGetEditorValue	56	EventCTGetEditorValue
CTInitializeControl	57	EventCTInitializeControl
CTIsReservedKey	58	EventCTIsReservedKey
CTIsReservedLocation	59	EventCTIsReservedLocation
CTIsValid	60	EventCTIsValid
CTGetPreferredSize	61	EventCTGetPreferredSize
CTGetReservedCursor	62	EventCTGetReservedCursor
CTPaintCell	63	EventCTPaintCell
CTSetValue	64	EventCTSetValue
CTStartEditing	65	EventCTStartEditing
CTStopEditing	66	EventCTStopEditing
CTStringFormat	67	EventCTStringFormat
CTStringUnFormat	68	EventCTStringUnFormat

Notes:

The Spread control provides a Script version of some of these events that you use in a scripting environment if you want to change any parameter that is not passed "ByVal". To activate a Script version of an event, you must set the ScriptEnhanced property to True. However, if you set the EventEnabled property to False for a specific event and you set the ScriptEnhanced property to True, the script version of the event will not occur.
If you use the ActiveX control, the DragDrop, DragOver, GotFocus, LostFocus, MouseDown, MouseMove, MouseUp, and Validate events are special events implemented by the container. Therefore, the EventEnabled property does not affect whether the DragDrop, DragOver, GotFocus, LostFocus, MouseDown, MouseMove, MouseUp, and Validate events occur.

Data Type

Integer (Boolean)