Xbasic

Form Functions and Methods

Description

Working with forms in Alpha Anywhere.

Name
Description
Form Control Methods

Alpha Anywhere provides the following and methods for manipulating form controls. Prefix the following methods with the pointer to the control.

Form Functions and Methods

A list of the form functions and methods provided in Alpha Anywhere.

Using the FORM.VIEW method

Assume that you have a form called "Print Invoices". The form prompts for the starting invoice number (in a control on the form called start_inv ) and the ending invoice number (in a control called end_inv ). The form also has three buttons: "Preview", "Print" and "Cancel".

Methods

FORM.ACTIVEPREVDRILLDOWN Method

The .ACTIVEPREVDRILLDOWN() method returns the name of previously active object, drilling down into container objects (embedded forms and browses).

FORM.BROWSE_VIEW Method

The .BROWSE_VIEW() method toggles a form window into a browse window.

FORM.BUTTON.PUSH Method

The .PUSH() method activates a button and runs the button's OnPush event.

FORM.CLOSE Method

The .CLOSE() method closes the layout window.

FORM.CREATE Method

The FORM.CREATE() method creates an on-the-fly form layout for the selected table or set and then displays the form in View mode.

FORM.DIALOG Method

The .DIALOG() method opens Form_Name as a dialog box. When the user closes the dialog, the object name of the last button pressed is stored in Last_Button. See Opening a Dialog Box for more information.

FORM.FIND_BY_FORM Method

The .FIND_BY_FORM() method puts the form into Find by Form mode.

FORM.FIND_CLEAR Method

The .FIND_CLEAR() method clears entries from the Find by Form mode form.

FORM.FIND_EXIT Method

The .FIND_EXIT() method cancels the Find by Form mode.

FORM.FIND_NEXT Method

The .FIND_NEXT() method repeats the Find by Form, finding the next record.

FORM.FIND_PREV Method

The .FIND_PREV() method repeats the Find by Form, finding the previous record.

FORM.FIND_RUN Method

The .FIND_RUN() method runs the find specified in the Find_by_Form window.

FORM.GET_HEIGHT Method

The .GET_HEIGHT() method returns the Height of a form in inches, given a display style.

FORM.GET_ROW_POSITIONS Method

The .GET_ROW_POSITIONS() method returns a CR-LF delimited string of row ending positions in inches.

FORM.GET_WIDTH Method

The .GET_WIDTH() method returns the Width of a data format in inches, given a display style.

FORM.LAST_PRESSED Method

The .LAST_PRESSED() method returns the name of the last button pressed when a form is opened as a dialog. See [Using the FORM.VIEW method] for details.

FORM.LOAD Method

The FORM.LOAD() method loads Form_Name into memory and returns an object pointer. The form window is hidden. To display the window, you must use the <FORM>.SHOW() method. Use the FORM.LOAD() method rather than the FORM.VIEW() or FORM.VIEWQUERIED() methods when you want to manipulate objects on the form, or set form properties, before making the form window visible.

FORM.MENUCHANGE Method

The .MENUCHANGE() method displays the named menu.

FORM.PREVIEW Method

The FORM.PREVIEW() method displays the Preview dialog box showing the selected form.

FORM.QUERY_BY_FORM Method

The .QUERY_BY_FORM() method switches a form to Query by Form mode.

FORM.QUERY_CLEAR Method

The .QUERY_CLEAR() method clears entries selected by Query by Form.

FORM.QUERY_EXIT Method

The .QUERY_EXIT() method exits from Query by Form mode.

FORM.QUERY_MODE Method

The .QUERY_MODE() method switches the Query_by_Form form to either "Filter" or "Order" mode.

FORM.QUERY_RUN Method

The .QUERY_RUN() method runs the query specified in the Query by Form window.

FORM.RECNO_GOTO Method

The .RECNO_GOTO() method makes the specified record number current.

Form.SaveAs Method

The Form.SaveAs() method prints Layout_Name to file in PDF, HTML, RTF, or TXT formats. If no format is specified, the PDF format is used.

FORM.SWAP Method

The .SWAP() method replaces the current form with a different form. Both forms have to be based on the same table.

FORM.TAB_OBJECT.TAB_GET Method

The .TAB_GET() method returns the tab number of the tab page that has focus. Works only for a tab object on a form.

FORM.TAB_OBJECT.TAB_SET Method

The .TAB_SET() method activates the specified tab page on a tab control on a form.

FORM.VIEW Method

Load and show a form

Form.ViewLinked Method

Opens a form and applies a filter and/or order expression. Link fields are automatically set when records are edited, or added. Style = "" for normal, "dialog", "hidden" or "hidden-dialog".

FORM.VIEWQUERIED Method

Opens a form and applies a filter and/or order expression. Style = "" for normal, "dialog", "hidden" or "hidden-dialog". If IsBaseQuery = .t. (default value), use cannot remove the filter expression.

FORM.WINDOW_POSITION Method

The .WINDOW_POSITION() method positions a form or browse on the screen. The "fill" option allows you to fill the entire Alpha Anywhere client area, without having to maximize the window. By avoiding having to maximize the window, other windows can be opened in a smaller window on top of the window that fills the screen.

FORM.ZOOM_TO_RECORD Method

The FORM.ZOOM_TO_RECORD() method opens a form and displays the current record in an embedded browse.

FORM.ZORDER Method

The .ZORDER() method sets the window's z-order stacking position. You ca change the Z-Order of a window i.e. Back,Front.

See Also