Browse Functions and Methods
Alpha Five provides the following Browse methods based on the default BROWSE object.
Method |
| Description |
V5 | Prints Layout_Name to file in the .PDF format. | |
V5 | Deletes the browse from disk. | |
V5 | Opens Form_Name as a dialog box. | |
V5 | Loads Browse Name into memory and returns an object pointer. | |
V5 | Displays the browse and the selected records in the Print Preview dialog. | |
V5 | Obsolete, see PRINT_BROWSE(). .PRINT()previews the print formatted browse on the screen. | |
V5 | Prints the browse to file in the specified format. If no format is specified, the .PDF format is used. | |
V5 | Opens Browse Name and returns an object pointer. | |
V5 | Opens Browse Name and returns an object pointer. | |
V5 | Positions a browse window on the screen. |
Alpha Five provides the following browse methods. The use of these methods requires the <BROWSE> pointer returned by the BROWSE.LOAD() method.
Method |
| Description |
V5 | Sets focus to the browse. | |
V5 | Returns the name of the column with focus. | |
V5 | Returns the column that has deepest focus. | |
V5 | Returns the name of the column which previously had focus. | |
V5 | Sets the Allow Changes flag for a form or browse. When the flag is .T., data can be edited. | |
V5 | Returns .T. (TRUE) if the layout allows editing; otherwise, it returns .F. (FALSE). | |
V5 | Prints Layout_Name to file in the .PDF format. | |
V5 | Sets the base filter and order expressions for a layout. | |
V5 | Cancels any changes made to the current record before the records is saved. | |
V5 | Put a browse layout into change mode, just as if the user had done so by beginning to type into any field. | |
V5 | Returns a pointer to the specified child object. | |
V5 | Returns a CR-LF separated list of all the child objects on the browse, in tab order. | |
V5 | Returns the number of objects that a browse object contains. | |
V5 | Returns the class (i.e., type) of the object. | |
V5 | Closes the form or browse window. | |
V5 | Saves the current record. | |
V5 | Copies the value from the corresponding field in the previous record into the current field. | |
V5 | Copies values from the previous record into the current record. | |
V5 | Returns the record number of the current browse row. | |
V5 | Returns the character position of the cursor. | |
V5 | Places the cursor at the specified character Position. | |
V5 | Returns the window mode of the layout. | |
V5 | Deletes the current record in a form or a browse. | |
V5 | Dials the phone number in the column and row that currently has focus. | |
V5 | Returns the name of the dictionary file that contains the browse. | |
V5 | Makes an object unable to receive focus. May also gray the object. Works with forms, browses, fields, buttons, check boxes, etc. | |
V5 | Moves the focus down as if the user had pressed the Down key. | |
V5 | Creates a new record that is a duplicate of the current record and then moves focus to the new record. | |
V5 | Makes an object able to receive focus. Works with forms, browses, fields, buttons, check boxes, etc. | |
V5 | Moves the focus to the end of the row as if the user had pressed the End key. | |
V5 | Interprets a character string as an Xbasic expression. | |
V5 | Moves to the first record in the current query. | |
V5 | Moves to the last record in the current query. Works with forms and browses. | |
V5 | Moves to the next record in the current query. | |
V5 | Moves to the previous record in the current query. Works with forms and browses. | |
V5 | Returns the current filter expression for the layout. | |
V5 | Does a Find by Key for value. If value is not specified, the built-in Find dialog is displayed. | |
V5 | Displays the Find and Replace dialog box. If layout has the Change mode restricted, then only the Find tab is shown. | |
V5 | A high level approach to displaying the Find by Key dialog box that allows you to customize its appearance and preset its filter. | |
V5 | Toggles a browse window into a form window. | |
V5 | Returns a pointer to the container of the object that has focus. | |
V5 | Returns .T. (TRUE) if the browse supports the named method. | |
V5 | Hides an object. | |
V5 | Moves the focus to the beginning of the row as if the user had pressed the Home key. | |
V5 | Returns the filename of the browse icon. | |
V5 | Returns the name of the current primary index or query. | |
V5 | Returns a pointer to the current primary index or query. | |
V5 | Selects an index or query list as the primary index for a form or browse. | |
V5 | Sets the primary index for the browse. | |
V6 | Displays the Primary Index or Query dialog box. | |
V5 | Returns .T. (TRUE) if the object is the last object on the browse, as specified in the browse's tab order. | |
V5 | Returns .T. (TRUE) if the browse is visible. | |
V5 | Returns the kind of object represented by a browse. | |
V5 | Moves the focus to the left as if the user had pressed the Left key. | |
V5 | Displays the Locate dialog box. | |
V5 | Finds the next record with a field value matching value. If field is not specified, all fields are searched. Otherwise, only the specified field is searched. | |
V5 | Finds the previous record with a field value matching value. If field is not specified, all fields are searched. Otherwise, only the specified field is searched. | |
V5 | Marks the current record. | |
V5 | Maximizes the browse window. | |
V5 | Displays or removes a checkmark next to a menu entry. | |
V5 | Enables or disables (grays) a menu entry. | |
V5 | Enables and removes any checkmarks from a menu entry. | |
V5 | Minimizes the browse window. | |
V5 | returns the current mode of the layout. Possible modes are: VIEW, CHANGE, ENTER, QUERY and FIND. | |
V5 | Displays the Multi-Select Records dialog box. | |
V5 | Returns the browse's name. | |
V5 | Displays the Goto which field? dialog box. | |
V5 | Enters a new record into a browse. | |
V5 | Moves the focus to the next control in the tab order as if the user had pressed the Tab key. | |
V5 | Returns the current order expression for the browse. | |
V5 | Sets the name of the file to be printed. It returns the name, if any, of the file currently set to be printed. | |
V5 | Moves the focus to the previous control in the tab order as if the user had pressed the Shift-Tab key. | |
V5 | Sets the printer configuration, and optionally, saves the current configuration before overwriting it. | |
V5 | Displays the Query by Expression dialog. | |
V5 | Opens the Query by Table dialog. | |
V5 | Displays the Query Genie dialog box. | |
V5 | Applies a query to the current browse. | |
V5 | Exports the currently selected records to Excel. | |
V5 | Performs the same action as the Quick Filter command. | |
V5 | Opposite of the .QUICK_SEARCH() methods. Finds all records that do NOT match the value in the current control. | |
V5 | Performs the same action as the Quick Sort command. Works with forms and browses. | |
V5 | Returns a count of the matching records, as if you had clicked the Quick Filter icon. | |
V5 | Performs the same action as the Quick Filter command and finds all records that match the value in the current control. | |
V5 | performs the opposite action as the Quick Filter command and finds all records that do NOT match the value in the current control. | |
V5 | Sorts the table or set on the indicated field and then displays it in the current browse. | |
V5 | Displays the Custom Sort dialog box. | |
V5 | Filters the records in a browse based on the value of a field. | |
V5 | Displays the multi-field Quick Filter dialog. | |
V5 | Returns the number of records displayed by the layout. | |
V5 | Returns the reference expression to reconstruct a reference to the object. | |
V5 | Forces the browse to re-fetch data from its data source, and then to repaint itself. Works with all controls. Note, this method does not re-query the table to see if the record content of the browse has changed. | |
V5 | Refreshes the browse, as if you had pressed Browse > Refresh Display. | |
V5 | Executes the .REFRESH() method on each cell on a browse. | |
V5 | Refreshes the browse, as if you had pressed Browse > Refresh Display. | |
V5 | Restores a minimized or maximized window to normal size. | |
V5 | Requeries the table, re-fetches all data for the form, and repaints the form. | |
V5 | Moves the focus to the right as if the user had pressed the Right key. | |
V5 | Displays the Right Click menu. | |
V5 | Runs a saved query. If Query_Name is not specified, Alpha Five prompts for a name. | |
V5 | Selects text in the current field from Start_Position for Length characters. | |
V5 | Returns a list of the currently selected record numbers. | |
V5 | Emails the browse. | |
V5 | Returns the session handle associated with the object. | |
V5 | Indicates that layout needs to be saved. | |
V6 | Displays the Select | |
V5 | Shows an object that may previously have been hidden using the .HIDE() method. Works with forms, browses, fields, buttons, check boxes, text, lines and most other objects on forms. | |
V5 | Turns off the current query and shows all records in the table (subject to any base filter that may have been specified in the form or browses Filter/Order properties). | |
V5 | Opens the memo editor for a memo field. Works with forms and browses. | |
V5 | Displays the Select Filter dialog box. | |
V5 | Displays the object specified by <OBJECT> and the Spellchecker dialog box. | |
V5 | Returns the <TBL> object pointer to the table that contains the data on the browse. | |
V5 | Switches the browse to a form display. | |
V5 | Loads and displays the selected toolbar. | |
V5 | Enables or disables the specified item on the control bar. | |
V5 | Returns the type of data bound to an browse. | |
V5 | Un-marks the current record. | |
V5 | Moves the focus up as if the user had pressed the Up key. | |
V5 | Returns a pointer to a dot variable that contains the values of the selected variables. | |
V6 | Sets the location of the browse on the screen. | |
V6 | Sets the stacking position of a browse. |
The following functions and methods are useful for manipulating browses.
Method |
| Description |
V5 | Returns a list of browses. | |
V5 | Returns the name of the file that contains the browse. | |
V5 | Displays the New Browse dialog, which allows you to select the fields that will appear in the new browse. | |
V5 | Opens the named layout in the appropriate editor. | |
V5 | Opens the default browse for the specified table. | |
V5 | Creates a temporary browse or form for the table or set defined by a provided table or set name. The resulting layout can be user modifiable or locked to prevent user modifications. | |
V5 | Returns the current setting of the Form > Allow Edits, or Browse > Allow Edits menu command. | |
BROWSE_OBJECTS_GET() | V5 | Returns a list of the columns on a browse. |
V5 | Closes a browse if it is open. | |
V5 | Returns the rows currently highlighted in a browse. | |
V5 | Deletes the named Form, Browse, Label, Letter, or Report. | |
V5 | Renames or copies the named Form, Browse, Label, Letter, or Report. | |
V5 | Previews the browse as it would appear if printed. | |
V5 | Creates the selected browse and then displays the Print dialog box. |