Class Form
Inheritance
| ScrollingWinControl | Form 🡄 ScrollingWinControl 🡄 CustomControl 🡄 WinControl 🡄 Control 🡄 Component 🡄 Object |
Properties
| AllowDropFiles | Allows files to be dragged into the form. |
| FormState | The current state of the form. |
| Menu | The main menu of the form. |
| ModalResult | The current ModalResult value of the form. |
| OnClose | The function to call when the form gets closed. |
| OnDropFiles | Called when files are dragged on top of the form. |
Methods
| bringToFront () | Brings the form to the foreground. |
| centerScreen () | Places the form at the center of the screen. |
| close () | Closes the form. |
| dragNow () | Starts dragging the Form. |
| getBorderStyle () | |
| getMenu () | Returns the mainmenu object of this form. |
| getOnClose () | Returns the function. |
| hide () | Hide the form. |
| isForegroundWindow () | Returns true if the specified form has focus. |
| printToRasterImage ( rasterimage ) | Draws the contents of the form to a rasterimage class object. |
| setBorderStyle ( borderstyle ) | Sets the borderstyle of the window. |
| setMenu ( menu ) | |
| setOnClose ( function ) | Return a CloseAction to determine how to close the window. |
| show () | Show the form. |
| showModal () | Show the form and wait for it to close and get the close result. |
Creation
| createForm () | Creates a new Form. |
Inheritance
- ScrollingWinControl
- Form 🡄 ScrollingWinControl 🡄 CustomControl 🡄 WinControl 🡄 Control 🡄 Component 🡄 Object
Properties
- AllowDropFiles
-
Allows files to be dragged into the form.
Type:
boolean - FormState
-
The current state of the form.
Possible values: fsCreating, fsVisible, fsShowing, fsModal, fsCreatedMDIChild, fsBorderStyleChanged, fsFormStyleChanged, fsFirstShow, fsDisableAutoSize
Type:
FormState string (ReadOnly) - Menu
-
The main menu of the form.
Type:
- ModalResult
-
The current ModalResult value of the form.
Note: When this value gets set the modal form will close
Type:
integer - OnClose
-
The function to call when the form gets closed.
Type:
function(sender) - OnDropFiles
-
Called when files are dragged on top of the form.
Filenames is an arraytable with the files.
Type:
function(sender, {filenames})
Methods
- bringToFront ()
- Brings the form to the foreground.
- centerScreen ()
- Places the form at the center of the screen.
- close ()
- Closes the form. Without an onClose this will be the same as hide.
- dragNow ()
-
Starts dragging the Form.
Call this on mousedown on any object if you wish that the mousemove will drag the whole Form arround. Useful for borderless windows (Dragging will stop when the mouse button is released).
- getBorderStyle ()
- getMenu ()
-
Returns the mainmenu object of this form.
Returns:
- getOnClose ()
-
Returns the function.
Returns:
-
function
- hide ()
- Hide the form.
- isForegroundWindow ()
-
Returns true if the specified form has focus.
Returns:
-
boolean
- printToRasterImage ( rasterimage )
-
Draws the contents of the form to a rasterimage class object.
Parameters:
- rasterimage
- setBorderStyle ( borderstyle )
-
Sets the borderstyle of the window.
Parameters:
- borderstyle
- setMenu ( menu )
-
Parameters:
- menu MainMenu
- setOnClose ( function )
-
Return a CloseAction to determine how to close the window.
function (sender)
Parameters:
- function
- show ()
- Show the form.
- showModal ()
- Show the form and wait for it to close and get the close result.