C1TrueDBGrid.DestinationRow Property

Gets the row which will be current after cell movement.

[Visual Basic]

Public ReadOnly Property DestinationRow As Integer

[C#]

public int DestinationRow {get;}

[Delphi]

public property DestinationRow: Int32 read get_DestinationRow;

Remarks

The value returned is the bookmark of the row containing the destination cell. If click occurs outside any visible row (for example, on the header), DestinationRow returns Null. If the AddNew row is clicked, DestinationRow returns " (empty string).

This property is available only during those events related to cell movement: AfterColEdit, AfterColUpdate, BeforeColUpdate, BeforeRowColChange, ButtonClick, Click, DoubleClick, FootClick, GroupHeadClick, HeadClick, MouseDown, and MouseUp. Any attempt to access the DestinationRow property outside of these events results in a trappable error ("Property not available in this context").

The property can only be used if the movement is initiated interactively by the user, via the keyboard or mouse. The property is not available when movement is initiated programmatically (for example, when using the grid's MoveNext method).

Note: Care must be exercised when using this property, because it is possible to use the value of this property in an event (such as MouseDown) before knowing whether or not the movement will actually succeed. The value returned by this property only indicates what the correct destination row will be if the cell movement is successful.

The DestinationRow property does not guarantee that the cell movement will succeed (for example, movement may fail if contents of the current cell are not valid). In such cases, the DestinationRow property will not reflect the actual destination position (usually the cell position will remain at the previous location).