Release 10.1A: OpenEdge Development:
Progress 4GL Reference

> ## BROWSE widget

> A browse widget lets you see data and select records from all the records associated with a database query. You can define a static browse widget with the DEFINE BROWSE statement or a dynamic browse widget with the CREATE BROWSE statement. The CREATE BROWSE is valid only in a graphical interface. A browse can be either a read-only tool for browsing through records, or it can be an editing tool for updating records, depending on the options you specify.

> You can move and resize the browse and its components. Specifically, in graphical interfaces, you can move and resize the browse, move and change the width of the browse-column, and change the height of the browse-row. You can do all this through direct manipulation (by pointing, clicking, and dragging) and through the 4GL. For more information, see OpenEdge Development: Progress 4GL Handbook .

> You can also use the mouse wheel to scroll the browse widget horizontally and vertically in Windows. When you rotate the mouse wheel up and down, the browse scrolls vertically up and down. When you rotate the mouse wheel up and down while holding down the CTRL key, the browse scrolls horizontally left and right. You can specify the number of rows the browse scrolls up and down per click of the mouse wheel on the Wheel tab in the Windows Mouse Properties dialog box (accessed through the Windows Control Panel).

> The following figure shows a read-only browse widget:

> The following figure shows an updateable browse. Note the inline editing capability in the focused row:

> #### Attributes

> When describing browse attributes, it is important to understand the scope of each attribute. An attribute can apply to:

> - The browse widget as a whole.

> - A single browse column.

> - A single browse cell. In this case, the attribute applies to only the single cell at the intersection of the named column and the focused row.

> - Both the browse as a whole and a cell or column. For example, in the same trigger, you could change the background color of the whole browse to blue and the background color of the current cell to yellow.

> When you want to reference an attribute that applies to the browse as a whole, the correct syntax is as follows:

>     browse-name:attribute-name IN FRAME frame-name  (for a static browse)
>     OR
>     browse-handle:attribute-name      (for a dynamic or static browse)

> The IN FRAME qualifier is only necessary for a static browse to avoid ambiguity.

> When an attribute applies to a column or a cell, the identifier is the field or variable name as listed in the DEFINE BROWSE statement. This identifier is known as the column name. The browse column’s widget-handle may also be used. Here is the syntax:

>     column-name:attribute-name IN BROWSE browse-name  (static browse column)
>     OR
>     column-handle:attribute-name       (dynamic or static browse column)

> The IN BROWSE qualifier is only necessary for a static browse to avoid ambiguity, but it is good programming practice to always include it, especially when you reference the same field as a separate widget type.

> The following table lists all the attributes for the browse widget, whether they are readable and writeable, and their scope:

> Attribute | Applies to
> --- | ---
> ALLOW-COLUMN-SEARCHING attribute3 | Browse
> AUTO-RESIZE attribute3 | Column
> AUTO-VALIDATE attribute | Column
> AUTO-ZAP attribute | Cell
> BGCOLOR attribute1 | Browse, cell
> BUFFER-FIELD attribute | Column
> COLUMN attribute | Browse, cell
> COLUMN-BGCOLOR attribute | Column
> COLUMN-DCOLOR attribute2 | Column
> COLUMN-FGCOLOR attribute | Column
> COLUMN-FONT attribute | Column
> COLUMN-MOVABLE attribute3 | Browse
> COLUMN-PFCOLOR attribute2 | Column
> COLUMN-READ-ONLY attribute | Column
> COLUMN-RESIZABLE attribute3 | Browse
> COLUMN-SCROLLING attribute | Browse
> CONTEXT-HELP-ID attribute | Browse
> CURRENT-COLUMN attribute | Browse
> CURRENT-ROW-MODIFIED attribute | Browse
> CURSOR-OFFSET attribute | Cell
> DATA-TYPE attribute | Column
> DCOLOR attribute2 | Browse, cell
> DISABLE-AUTO-ZAP attribute | Column
> DOWN attribute3 | Browse
> DROP-TARGET attribute | Browse
> DYNAMIC attribute | Browse
> EDIT-CAN-PASTE attribute1,3 | Column
> EDIT-CAN-UNDO attribute | Column
> EXPANDABLE attribute3 | Browse
> FGCOLOR attribute1 | Browse, cell
> FIRST-COLUMN attribute | Browse
> FIT-LAST-COLUMN attribute | Browse
> FOCUSED-ROW attribute | Browse
> FOCUSED-ROW-SELECTED attribute | Browse
> FONT attribute1 | Browse, cell
> FRAME attribute | Browse
> FRAME-COL attribute | Browse
> FRAME-NAME attribute | Browse
> FRAME-ROW attribute | Browse
> FRAME-X attribute | Browse
> FRAME-Y attribute | Browse
> HANDLE attribute | Browse, cell
> HEIGHT-CHARS attribute3 | Browse, cell
> HEIGHT-PIXELS attribute3 | Browse, cell
> HELP attribute | Browse, column
> HIDDEN attribute | Browse
> HWND attribute3 | Browse
> INPUT-VALUE attribute | Cell
> LABEL attribute | Column
> LABELS attribute3 | Browse
> LABEL-BGCOLOR attribute | Column
> LABEL-DCOLOR attribute2 | Column
> LABEL-FGCOLOR attribute | Column
> LABEL-FONT attribute | Column
> MAX-DATA-GUESS attribute | Browse
> MENU-KEY attribute | Browse
> MENU-MOUSE attribute1 | Browse
> MIN-COLUMN-WIDTH-CHARS attribute | Browse
> MIN-COLUMN-WIDTH-PIXELS attribute | Browse
> MODIFIED attribute | Browse, column
> MOUSE-POINTER attribute | Browse, column
> MOVABLE attribute1,3 | Browse, column
> MULTIPLE attribute | Browse
> NAME attribute | Browse, cell
> NEW-ROW attribute | Browse
> NEXT-COLUMN attribute | Column
> NEXT-SIBLING attribute | Browse
> NEXT-TAB-ITEM attribute | Browse
> NO-EMPTY-SPACE attribute | Browse
> NO-VALIDATE attribute | Browse
> NUM-COLUMNS attribute | Browse
> NUM-DROPPED-FILES attribute | Browse
> NUM-ITERATIONS attribute | Browse
> NUM-LOCKED-COLUMNS attribute | Browse
> NUM-SELECTED-ROWS attribute | Browse
> NUM-VISIBLE-COLUMNS attribute | Browse
> PARENT attribute | Browse
> PFCOLOR attribute2 | Cell
> POPUP-MENU attribute | Browse
> PREV-COLUMN attribute | Column
> PREV-SIBLING attribute | Browse
> PREV-TAB-ITEM attribute | Browse
> PRIVATE-DATA attribute | Browse, column
> QUERY attribute | Browse
> READ-ONLY attribute | Browse, column
> REFRESHABLE attribute | Browse
> RESIZABLE attribute1,3 | Browse, column
> ROW attribute | Browse, cell
> ROW-HEIGHT-CHARS attribute3 | Browse
> ROW-HEIGHT-PIXELS attribute3 | Browse
> ROW-RESIZABLE attribute3 | Browse
> ROW-MARKERS attribute | Browse
> SCREEN-VALUE attribute | Cell
> SCROLLBAR-VERTICAL attribute3 | Browse
> SELECTABLE attribute1,3 | Browse
> SELECTED attribute1,3 | Browse
> SELECTION-END attribute | Column
> SELECTION-START attribute | Column
> SELECTION-TEXT attribute | Column
> SENSITIVE attribute | Browse
> SEPARATORS attribute3 | Browse
> SEPARATOR-FGCOLOR attribute3 | Browse
> TAB-POSITION attribute | Browse
> TAB-STOP attribute | Browse
> TABLE attribute | Column
> TEXT-SELECTED attribute | Column
> TITLE attribute | Browse
> TITLE-BGCOLOR attribute1 | Browse
> TITLE-DCOLOR attribute2 | Browse
> TITLE-FGCOLOR attribute1 | Browse
> TITLE-FONT attribute1 | Browse
> TOOLTIP attribute1,3 | Browse
> TYPE attribute | Browse, cell
> VIEW-FIRST-COLUMN-ON-REOPEN attribute | Browse
> VISIBLE attribute4 | Browse, column
> WIDGET-ID attribute 1,3 | Browse
> WIDTH-CHARS attribute3 | Browse, column
> WIDTH-PIXELS attribute3 | Browse, column
> WINDOW attribute | Browse
> X attribute | Browse, cell
> Y attribute | Browse, cell
> Graphical interfaces only. Character interfaces only. Windows only. Windows only for column only.

> #### Methods

> ADD-CALC-COLUMN( ) method | ADD-COLUMNS-FROM( ) method
> ADD-LIKE-COLUMN( ) method | CLEAR-SELECTION( ) method
> CREATE-RESULT-LIST-ENTRY( ) method | DELETE-CURRENT-ROW( ) method
> DELETE-RESULT-LIST-ENTRY( ) method | DELETE-SELECTED-ROW( ) method
> DELETE-SELECTED-ROWS( ) method | DESELECT-FOCUSED-ROW( ) method
> DESELECT-ROWS( ) method | DESELECT-SELECTED-ROW( ) method
> EDIT-CLEAR( ) method | EDIT-COPY( ) method
> EDIT-CUT( ) method | EDIT-PASTE( ) method
> EDIT-UNDO( ) method | END-FILE-DROP( ) method
> FETCH-SELECTED-ROW( ) method | GET-BROWSE-COLUMN( ) method
> GET-DROPPED-FILE( ) method | GET-REPOSITIONED-ROW( ) method
> INSERT-ROW( ) method | IS-ROW-SELECTED( ) method
> LOAD-MOUSE-POINTER( ) method | MOVE-AFTER-TAB-ITEM( ) method
> MOVE-BEFORE-TAB-ITEM( ) method | MOVE-COLUMN( ) method
> MOVE-TO-BOTTOM( ) method | MOVE-TO-TOP( ) method
> REFRESH( ) method | SCROLL-TO-CURRENT-ROW( ) method
> SCROLL-TO-SELECTED-ROW( ) method | SELECT-ALL( ) method
> SELECT-FOCUSED-ROW( ) method | SELECT-NEXT-ROW( ) method
> SELECT-PREV-ROW( ) method | SELECT-ROW( ) method
> SET-REPOSITIONED-ROW( ) method | SET-SELECTION( ) method
> VALIDATE( ) method |

> #### Events

> Default keyboard events | Developer events
> Field editing key function events | Mouse events
> Navigation key function events | Universal key function events
> DEFAULT-ACTION | DESELECTION
> DROP-FILE-NOTIFY | END statement
> END-MOVE1 | END-RESIZE1
> END-ROW-RESIZE1 | END-SEARCH1
> ENTRY statement | LEAVE statement
> OFF-END | OFF-HOME
> ROW-DISPLAY | ROW-ENTRY
> ROW-LEAVE | SCROLL-NOTIFY
> SELECTION | START-MOVE1
> START-RESIZE1 | START-ROW-RESIZE1
> START-SEARCH1 | VALUE-CHANGED
> Windows only.

> #### See also

> The chapter on the browse in OpenEdge Development: Progress 4GL Handbook .

Copyright © 2005 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095