DataWindow.Skip Method (Typed) | |
Move forward or backward in the server by a specified number of records.
Namespace:
XSharp.VO.SDK
Assembly:
XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.21
Syntax VIRTUAL METHOD Skip(
uRelativePosition
) AS LOGIC CLIPPER
[ClipperCallingConventionAttribute(new string[] { ... })]
public virtual bool Skip(
Usual uRelativePosition = default
)
Request Example
View SourceParameters
- uRelativePosition (Optional)
- Type: Usual
The number of records to be moved. Positive numbers more forward, negative numbers move backward. The default is +1.
Return Value
Type:
Logic
TRUE if operation was successful; otherwise, FALSE. Skip() can fail for several different reasons. It can fail validation, there may not be that many records to move, the write that precedes the move can fail because of lock conflicts with other users that control the server, or the server can have become unavailable due to technical problems. Use DataWindow:Status to determine the reason for the failure.
Remarks
This method is subject to validation (i.e., if the data in the window fails validation, the movement is refused).
The method does not explicitly refresh the contents of the window after the move; this is done automatically by the NotifyRecordChange message that follows.
Because it takes a numeric argument, the Skip() method is rarely connected directly with a push button or menu command: for simple movements, use the SkipNext() and SkipPrevious() methods. Skip() provides a lot of flexibility but is usually called from code, in methods of the data window.
See Also