TSBrowse Class Methods:

 

 

Method New()   Constructor  from source code of the Class.

 

Parameters:    nRow, nCol, nWidth, nHeigth, bLine, aHeaders, aColSizes, oWnd, cField, uVal1, uVal2,   bChange, bLDblClick,   bRClick, oFont, oCursor, aColors, cMsg, lUpdate, cAlias, lPixel, bWhen, lDesign, bValid, lCellBrw, nStyle, bLClick, aActions

 

Method ReDefine()  Constructor from resources of the Class.

 

Parameters:    nId, bLine, oDlg, aHeaders, aColSizes, cField, uVal1, uVal2, bChange, bLDblClick, bRClick, oFont, oCursor, nClrFore, nClrBack, cMsg, lUpdate, cAlias, bWhen, bValid, lCellBrw, bLClick

 

If you need more information about the constructor Methods, see help on Create commands of Browse . 

 

Method AddColumn( oColumn )  It adds a column to Browse, previously defined with the constructor column method TSColumn:New() , or with the Command DEFINE COLUMN oColumn ..

 

Method BeginPaint()  Internal use, called from method Display() .

 

Method BugUp()   It calls Method UpStable().

 

Method ChangeFont( oFont, nColumn, nLevel )

 

Method DbSkipper( nToSkip )  Internally used; it controls the database record pointer.

 

Method Default()  Internal use; actions to initialize the Browser.

 

Method DeleteRow()

 

Method DelColumn( nPos )

 

Method Destroy()  Internal use; it destroys the Browse control.

 

Method Display()   Internal use- First time display of the Browse. 

 

Method DrawLine( nRow )  It paints the active row or nRow.  

 

Method DrawSelect()  It paints the cursor on the active row. 

 

Method DrawHeaders()  It draws Headers, Footers, and Super-Headers.

 

Method DrawFooters()  It draws the Footers.

 

Method DrawSuper()  It draws the Super-Headers.

 

Method EndPaint()  Internal use, called from Method Display().  

 

Method Exchange( nCol1, nCol2 )  It exchanges the column positions of the columns nCol1 and nCol2. 

 

Method GetColSizes()  It returns an array containing the widths of the columns in pixels.

 

Method GetColumn( nCol ) It returns a TSColumn object reference corresponding to nCol.  

 

Method GoBottom()  It positions the cursor on the last row of the Browse, moving the record pointer to the last record of the database, or to the last element of other objects ( Array, oDbf, Text, Tree, oCtx ). It is executed when the keys Ctrl+End or Ctrl+PgDn are pressed, or when dragging to the end the vertical scroll bar.       

 

Method GoDown()  It positions the cursor one row down moving the pointer to the next record in database, or the next element on other objects. It is executed when the Down Arrow key is pressed. 

 

Method GoEnd()  It positions the cursor on the last visible column on screen.

 

Method GoHome()  It positions the cursor on the first visible column on screen. 

 

Method GoLeft()  It moves the cursor one column Left.

 

Method GoNext()  It moves the cursor to the next editable column to the Right, or to the first editable column on the next row.

 

Method GoPos( nNewRow, nNewCol )  It moves the cursor on the row nNewRow and column nNewCol.  

 

Method GoRight()  It moves the cursor one column Right.

 

Method GotFocus()  Uso interno, algunas acciones al recibir el foco el Browse, entre las que destaca la evaluación del bloque de código bGotFocus.

 

Method GoTop() It positions the cursor on the first row of the Browse, moving the record pointer to the first database record, or the first element of the other objects ( Array, oDbf, Text, Tree, oCtx ).

 

Method GoUp()  It positions the cursor one row up, moving the pointer to the previous database record, or the previous element on other objects. 

 

Method HiliteCell( nCol )  It positions the cursor on the column nCol. If used when activating the Browse, it will be displayed with the cursor on this column.

 

Method InsColumn( nPos, oColumn ) It inserts a column (object TSColumn oColumn ) in the position nPos.

 

Method KeyChar( nKey, nFlags )  Internal use.- It executes actions depending on the key nKey pressed. It evaluates the Code Block bKeyChar.   

 

Method KeyDown( nKey, nFlags )  Internal use.- Similar to KeyChar(). It evaluates the Code Block bKeyDown. 

 

Method LButtonDown( nRowPix, nColPix, nKeyFlags )  Internal use.- It executes related actions with the Left Click of the mouse. It evaluates the Code Block bLClick.       

 

Method LDblClick( nRowPix, nColPix, nKeyFlags )   Internal use.- It executes related actions with the Double Click of the mouse. It evaluates the Code Block bLDblClick.    

 

Method lEditCol( nCol, uVar, cPicture, bValid, nClrFore, nClrBack, cMsg, cError, bWhen, lSpinner, bUp, bDown, bMin, bMax )  It executes the data editing of the cells. You can use this method from your program in personalized editing functions. This Method will return a value of .T. (True) if the editing ended normally, and .F. (False) if the user cancelled editing.      

 

Method lIgnoreKey( nKey, nFlags )

 

Method LoadFields( lEditable )

 

Method Look3D( lOnOff, nColumn, nLevel, lPhantom )

 

Method LostFocus( hCtlFocus )  Internal use. It is activated when the Browse looses focus. It evaluates the Code Block  bLostFocus.  

 

Method MButtonDown( nRow, nCol, nKeyFlags )  Internal use.- It is activated when the central mouse button is pressed (on 3-button-mouse). It evaluates the Code Block  bMButtonDown, receiving the same parameters.   

 

Method MoveColumn( nColPos, nNewPos )  It changes the position of one column inside the Browse, if the variable ::lMoveCols is .T. .

 

Method nLogicPos()  It returns the logical position inside the active index. 

 

Method nRowCount()  Internal use.- It counts the displayable rows of the Browse.

 

Method PageUp( )  It moves the cursor and the record pointer one page Up. It is executed when pressing the key PgUp.

 

Method PageDown( )  It moves the cursor and the record pointer one page Down. It is executed when pressing the key PgDn.   

 

Method Paint()  Internal use.- it paints the Browse. Called from Method Display().

 

Method PanHome()  It moves the cursor to the first column of the current row. It is activated when pressing the keys Shift+LeftArrow. 

 

Method PanEnd()  It moves the cursor to the last column of the current row. It is activated when pressing the keys Shift+RightArrow.

 

Method PanLeft()  It moves the cursor to the first visible column of the current row. Pressing the Home key activates it.

 

Method PanRight()  It moves the cursor to the last visible column of the current row. Pressing the End key activates it. 

 

Method RButtonDown( nRowPix, nColPix, nKeyFlags )  Internal use.- it executes actions related to the Right Click of the mouse. It evaluates the Code Block bRClicked.  If the click is done inside the Header area, TSBrowse will display a PopUp menu with options of column and cursor moves.

 

Method Report( cTitle, lPreview, oFont, nLang, cCaption, lModal )

 

Method Reset()  It moves the cursor and the record pointer to the top of the Browse and executes the Method Refresh(.T.)

 

Method ResetBarPos( lInit )  Internal use.- It Defines navigation blocks of the browse and adjusts the position of the scrolling bars.

 

Method ResetSeek()  It restors the value of the variable cSeek to Null, so a new Incremental Seek can be performed.

 

Method Seek( nKey )  This Method does all the work for the Incremental Seek.

 

Method Set3DText( lOnOff, lRaised, nColumn, nLevel, nClrLight, nClrShadow )

 

Method SetAlign( nColumn, nLevel, nAlign )

 

Method SetBtnGet( nCol, cResName, bAction, nBmpWidth )

 

Method SetDeleteMode( lOnOff, lConfirm, bDelete )

 

Method SetAppendMode( lMode )  It activates the automatic append feature.

 

Method SetArray( aArray ) 

 

Method SetColor( xColor1, xColor2, nColumn )

 

Method SetContext( oCtx )

 

Method SetColSize( nCol, nWidth )

 

Method SetData( nColumn, bData, aList )

 

Method SetFilter( cField, uVal1, uVal2 )

 

Method SetIndexCols( aCols )

 

Method SetoDBF( oDbf )

 

Method SetOrder( nColumn )

 

Method SetSelectMode( lOnOff, bSelected )

 

Method SetSpinner( nColumn, lOnOff, bUp, bDown, bMin, bMax )

 

Method SetTree( oTree )

 

Method SetTxtFile( oTxtFile, cTitle, lOemToAnsi )

 

Method ShowSizes()

 

Method Skip( n )

 

Method SwitchCols( nCol1, nCol2 )

 

Method SyncChild( aoChildBrw, abAction )

 

Method UpStable()

 

Method Proper( cText )  it converts the text cText  into capital initials.