SftTree/OCX 7.0

SftTree.EditEnding Event

Softel vdm, Inc.

Cell editing is ending.

Syntax       

VB.NET

Private Sub object_EditEnding(ByVal sender As Object, ByVal e As EventArgumentType) Handles object.EditEnding

VB

Private Sub object_EditEnding(ByVal Window As OLE_HANDLE, ByVal vData As Variant, ByVal EditIndex As Long, ByVal EditCol As Integer, ByVal SaveInput As Boolean)

C#.NET

void object_EditEnding(object sender, EventArgumentType e);

VC++

void OnEditEndingobject(OLE_HANDLE Window, const _variant_t& vData, long EditIndex, short EditCol, VARIANT_BOOL SaveInput);

C

HRESULT OnEditEndingobject(OLE_HANDLE Window, VARIANT vData, long EditIndex, short EditCol, VARIANT_BOOL SaveInput);

Delphi

procedure objectEditEnding(Sender: TObject; Window : Cardinal; vData : OleVariant; EditIndex : Integer; EditCol : Smallint; SaveInput : WordBool);

object

A SftTree object.

Window

The window handle of the control being used for cell editing.

vData

Application-specific data provided as vData argument when Cell.Edit was called.

EditIndex

The zero-based index of the item being edited.  The combination of EditIndex and EditCol describes an individual cell.

EditCol

The zero-based column number.  The combination of EditIndex and EditCol describes an individual cell.

SaveInput

True if the new input data should be saved in the tree control, False otherwise.  The value of SaveInput was returned by the application's EditValidate event as InputValid argument.

Comments

The EditEnding event occurs when cell editing is ending.

This event occurs every time cell editing for one cell is about to end.  This event should only be used to save input data in the tree control and to hide and disable the control used for cell editing.  This event should not take any other action or update the tree control in any other way.  If the control is in virtual mode, the VirtualItemChanged method can be used to mark the item and cell as modified.

SftTree/OCX automatically hides and disables the control used for cell editing based (the Window handle provided in the EditInitializing event).  However, many environments (including .NET) and ActiveX controls require that the application hide and disable controls explicitly.

After the EditEnding event occurs, another cell could be edited automatically as the result of cell navigation. 

The EditValidate event can be used to validate the contents of the cell being edited.  The EditValidate event precedes the EditEnding event.

The EditEnded event occurs once cell editing has completely ended.

See Also  SftTree Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com