Browse Functions and Methods

IN THIS PAGE

Description

Alpha Anywhere provides the following Browse methods based on the default BROWSE object.

  • .ARCHIVE 

    Prints Layout_Name to file in the .PDF format.

  • .DELETE() 

    Deletes the browse from disk.

  • .DIALOG() 

    Opens Form_Name as a dialog box.

  • .LOAD() 

    Loads Browse Name into memory and returns an object pointer.

  • .PREVIEW() 

    Displays the browse and the selected records in the Print Preview dialog.

  • .PRINT() 

    Obsolete, see PRINT_BROWSE(). .PRINT()previews the print formatted browse on the screen.

  • .SAVEAS() 

    Prints the browse to file in the specified format. If no format is specified, the .PDF format is used.

  • .VIEW() 

    Opens Browse Name and returns an object pointer.

  • .VIEWQUERIED() 

    Opens Browse Name and returns an object pointer.

  • .WINDOW_POSITION() 

    Positions a browse window on the screen.

Alpha Anywhere provides the following browse methods. The use of these methods requires the pointer returned by the BROWSE.LOAD() method.

  • ACTIVATE() 

    Sets focus to the browse.

  • .ACTIVE() 

    Returns the name of the column with focus.

  • .ACTIVE_DRILLDOWN() 

    Returns the column that has deepest focus.

  • .ACTIVE_PREV() 

    Returns the name of the column which previously had focus.

  • .ALLOW_CHANGE() 

    Sets the Allow Changes flag for a form or browse. When the flag is .T., data can be edited.

  • .ALLOWCHANGESTATUS() 

    Returns .T. (TRUE) if the layout allows editing; otherwise, it returns .F. (FALSE).

  • .ARCHIVE() 

    Prints Layout_Name to file in the .PDF format.

  • .BASEQUERYRUN() 

    Sets the base filter and order expressions for a layout.

  • .CANCEL() 

    Cancels any changes made to the current record before the records is saved.

  • .CHANGE_MODE() 

    Put a browse layout into change mode, just as if the user had done so by beginning to type into any field.

  • .CHILD() 

    Returns a pointer to the specified child object.

  • .CHILD_ENUM() 

    Returns a CR-LF separated list of all the child objects on the browse, in tab order.

  • .CHILDREN() 

    Returns the number of objects that a browse object contains.

  • .CLASS() 

    Returns the class (i.e., type) of the object.

  • .CLOSE() 

    Closes the form or browse window.

  • .COMMIT() 

    Saves the current record.

  • .COPY_PREV_FIELD() 

    Copies the value from the corresponding field in the previous record into the current field.

  • .COPY_PREV_RECORD() 

    Copies values from the previous record into the current record.

  • .CURRENT_RECORD() 

    Returns the record number of the current browse row.

  • .CURSOR_GET() 

    Returns the character position of the cursor.

  • .CURSOR_SET() 

    Places the cursor at the specified character Position.

  • .DATA_ENTRY_STYLE() 

    Returns the window mode of the layout.

  • .DELETE_RECORD() 

    Deletes the current record in a form or a browse.

  • .DIAL_PHONE() 

    Dials the phone number in the column and row that currently has focus.

  • .DICTIONARY_GET() 

    Returns the name of the dictionary file that contains the browse.

  • .DISABLE() 

    Makes an object unable to receive focus. May also gray the object. Works with forms, browses, fields, buttons, check boxes, etc.

  • .DOWN() 

    Moves the focus down as if the user had pressed the Down key.

  • .DUPLICATE_RECORD() 

    Creates a new record that is a duplicate of the current record and then moves focus to the new record.

  • .ENABLE() 

    Makes an object able to receive focus. Works with forms, browses, fields, buttons, check boxes, etc.

  • .END() 

    Moves the focus to the end of the row as if the user had pressed the End key.

  • .EVAL() 

    Interprets a character string as an Xbasic expression.

  • .FETCH_FIRST() 

    Moves to the first record in the current query.

  • .FETCH_LAST() 

    Moves to the last record in the current query. Works with forms and browses.

  • .FETCH_NEXT() 

    Moves to the next record in the current query.

  • .FETCH_PREV() 

    Moves to the previous record in the current query. Works with forms and browses.

  • .FILTER_GET() 

    Returns the current filter expression for the layout.

  • .FIND() 

    Does a Find by Key for value. If value is not specified, the built-in Find dialog is displayed.

  • .FIND_AND_REPLACE() 

    Displays the Find and Replace dialog box. If layout has the Change mode restricted, then only the Find tab is shown.

  • .FINDBY_DEFINEDKEY() 

    A high level approach to displaying the Find by Key dialog box that allows you to customize its appearance and preset its filter.

  • .FORM_VIEW() 

    Toggles a browse window into a form window.

  • .GETACTIVEOBJPARENT() 

    Returns a pointer to the container of the object that has focus.

  • .HAS_METHOD() 

    Returns .T. (TRUE) if the browse supports the named method.

  • .HIDE() 

    Hides an object.

  • .HOME() 

    Moves the focus to the beginning of the row as if the user had pressed the Home key.

  • .ICON_GET() 

    Returns the filename of the browse icon.

  • .INDEX_NAME() 

    Returns the name of the current primary index or query.

  • .INDEX_POINTER() 

    Returns a pointer to the current primary index or query.

  • .INDEX_SET() 

    Selects an index or query list as the primary index for a form or browse.

  • .INDEX_SETEXPLICIT() 

    Sets the primary index for the browse.

  • .IndexSetDialog() 

    Displays the Primary Index or Query dialog box.

  • .IS_ON_LAST_OBJECT() 

    Returns .T. (TRUE) if the object is the last object on the browse, as specified in the browse's tab order.

  • .ISVISIBLE() 

    Returns .T. (TRUE) if the browse is visible.

  • .KINDOF() 

    Returns the kind of object represented by a browse.

  • .LEFT() 

    Moves the focus to the left as if the user had pressed the Left key.

  • .LOCATE() 

    Displays the Locate dialog box.

  • .LOCATE_NEXT() 

    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.

  • .LOCATE_PREV() 

    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.

  • .MARK_RECORD() 

    Marks the current record.

  • .MAXIMIZE() 

    Maximizes the browse window.

  • .MENUITEMCHECK() 

    Displays or removes a checkmark next to a menu entry.

  • .MENUITEMENABLE() 

    Enables or disables (grays) a menu entry.

  • .MENUITEMRESET() 

    Enables and removes any checkmarks from a menu entry.

  • .MINIMIZE() 

    Minimizes the browse window.

  • .MODE_GET() 

    returns the current mode of the layout. Possible modes are: VIEW, CHANGE, ENTER, QUERY and FIND.

  • .MULTI_SELECT() 

    Displays the Multi-Select Records dialog box.

  • .NAME() 

    Returns the browse's name.

  • .NAVIGATOR() 

    Displays the Goto which field? dialog box.

  • .NEW_RECORD() 

    Enters a new record into a browse.

  • .NEXT() 

    Moves the focus to the next control in the tab order as if the user had pressed the Tab key.

  • .ORDER_GET() 

    Returns the current order expression for the browse.

  • .OUPUT_FILE_OVERRIDE() 

    Sets the name of the file to be printed. It returns the name, if any, of the file currently set to be printed.

  • .PREV() 

    Moves the focus to the previous control in the tab order as if the user had pressed the Shift-Tab key.

  • .PRINTER_OVERRIDE() 

    Sets the printer configuration, and optionally, saves the current configuration before overwriting it.

  • .QUERY_BY_EXPN() 

    Displays the Query by Expression dialog.

  • .QUERY_BY_TABLE() 

    Opens the Query by Table dialog.

  • .QUERY_GENIE() 

    Displays the Query Genie dialog box.

  • .QUERYRUN() 

    Applies a query to the current browse.

  • .QUICK_EXPORT() 

    Exports the currently selected records to Excel.

  • . QUICK_SEARCH() 

    Performs the same action as the Quick Filter command.

  • .QUICK_SEARCHEXCL() 

    Opposite of the .QUICK_SEARCH() methods. Finds all records that do NOT match the value in the current control.

  • .QUICK_SORT() 

    Performs the same action as the Quick Sort command. Works with forms and browses.

  • .QUICKFILTER() 

    Returns a count of the matching records, as if you had clicked the Quick Filter icon.

  • .QUICK_SEARCH() 

    Performs the same action as the Quick Filter command and finds all records that match the value in the current control.

  • .QUICK_SEARCHEXCL() 

    performs the opposite action as the Quick Filter command and finds all records that do NOT match the value in the current control.

  • .QUICKSORTEXPLICIT() 

    Sorts the table or set on the indicated field and then displays it in the current browse.

  • .QUICKSORTMULTIFLD() 

    Displays the Custom Sort dialog box.

  • .QUICKSRCHEXPLICIT() 

    Filters the records in a browse based on the value of a field.

  • .QUICKSRCHMULTIFLD() 

    Displays the multi-field Quick Filter dialog.

  • .RECORDS_GET() 

    Returns the number of records displayed by the layout.

  • .REFERENCE_EXPRESSION_GET() 

    Returns the reference expression to reconstruct a reference to the object.

  • .REFRESH() 

    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.

  • .REFRESH_BROWSE() 

    Refreshes the browse, as if you had pressed Browse > Refresh Display.

  • .REFRESH_FIELDS() 

    Executes the .REFRESH() method on each cell on a browse.

  • .REFRESH_LAYOUT() 

    Refreshes the browse, as if you had pressed Browse > Refresh Display.

  • .RESTORE() 

    Restores a minimized or maximized window to normal size.

  • .RESYNCH() 

    Requeries the table, re-fetches all data for the form, and repaints the form.

  • .RIGHT() 

    Moves the focus to the right as if the user had pressed the Right key.

  • .RIGHTCLICK() 

    Displays the Right Click menu.

  • .RUN_SAVED_QUERY() 

    Runs a saved query. If Query_Name is not specified, Alpha Anywhere prompts for a name.

  • .SELECT_TEXT() 

    Selects text in the current field from Start_Position for Length characters.

  • .SELECTED_RECORDS() 

    Returns a list of the currently selected record numbers.

  • .SEND() 

    Emails the browse.

  • .SESSIONHANDLE() 

    Returns the session handle associated with the object.

  • .SET_DIRTY() 

    Indicates that layout needs to be saved.

  • .IndexSetDialog() 

    Displays the Select

  • .SHOW() 

    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.

  • .SHOW_ALL() 

    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).

  • .SHOW_MEMO() 

    Opens the memo editor for a memo field. Works with forms and browses.

  • .SPECIALQUERIES() 

    Displays the Select Filter dialog box.

  • .SPELL_CHECK() 

    Displays the object specified by and the Spellchecker dialog box.

  • .TABLE_GET() 

    Returns the object pointer to the table that contains the data on the browse.

  • .TOGGLE_FORMBROWSE() 

    Switches the browse to a form display.

  • .TOOLBARCHANGE() 

    Loads and displays the selected toolbar.

  • .ToolbarControlEnable() 

    Enables or disables the specified item on the control bar.

  • .TYPE() 

    Returns the type of data bound to an browse.

  • .UNMARK_RECORD() 

    Un-marks the current record.

  • .UP() 

    Moves the focus up as if the user had pressed the Up key.

  • .VARIABLES() 

    Returns a pointer to a dot variable that contains the values of the selected variables.

  • .WINDOW_POSITION() 

    Sets the location of the browse on the screen.

  • .ZORDER() 

    Sets the stacking position of a browse.

The following functions and methods are useful for manipulating browses.