Classes

Message XbpBrowse():xbeBRW_Navigate Foundation

The browse cursor must be navigated.

Syntax
:navigate := {| @nNavigate, mp2, self | ... }
:navigate ( <nNavigate>, <mp2> ) --> self 
Parameters
<nNavigate>
<nNavigate> is a numeric value which indicates the direction in which to move the browse cursor. It corresponds to constants defined in XBP.CH, which are listed below:
First message parameter for :navigate
Constant Navigation
XBPBRW_Navigate_NextLine One row down
XBPBRW_Navigate_PrevLine One row up
XBPBRW_Navigate_NextPage One page down
XBPBRW_Navigate_PrevPage One page up
XBPBRW_Navigate_GoTop To the beginning of a table
XBPBRW_Navigate_GoBottom To the end of a table
XBPBRW_Navigate_GoPos Go to position of <mp2>. Second message parameter indicates the percentage position in the table
XBPBRW_Navigate_NextCol One column to the right
XBPBRW_Navigate_PrevCol One column to the left
XBPBRW_Navigate_FirstCol To the first column
XBPBRW_Navigate_LastCol To the last column
XBPBRW_Navigate_Skip Skip <mp2> numbers of records. Second message parameter indicates the number of records to SKIP
XBPBRW_Navigate_SkipCols Skip <mp2> numbers of columns. Second message parameter indicates the number of columns to SKIP
<nNavigate> is passed by reference to the code block in the :navigate instance variable. Its value is examined by the XbpBrowse object after the code block returns.
<mp2>
The second message parameter indicates how many rows or columns the browser is requested to navigate the browse cursor.
Return

The method returns a reference to the XbpBrowse object.

Description

When the xbeBRW_Navigate event is created, the browse cursor must be moved. The first message parameter indicates the direction and how far the cursor is to be moved.

Default handling of the xbeBRW_Navigate event automatically executes the method :navigate() to move the browse cursor. The default handling can be overriden by assigning the value NIL to the <nNavigate> parameter passed to the code block. If NIL is contained in <nNavigate> after the code block returns, the method :navigate() is not automatically executed. This is useful for applications which implement custom navigation using the :navigate code block.

Feedback

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.