Form

From Lianjapedia
Jump to: navigation, search

Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.

Description

Form

Forms are standalone containers used to contain other containers and controls.

Properties

This class supports the Common Properties plus the following:

Property Access (R/RW) Value Description
Accepted RW Boolean When a form is being closed the beforeclose() event is dispatched to the object (any supported scripting language). You can validate the data in the form and reject the "close" operation by setting accepted to false, default is true.
Actionbar RW Boolean Whether form has an actionbar.
AlwaysOnBottom RW Boolean Whether form should always be on the bottom
AlwaysOnTop RW Boolean Whether form should always be on top
AutoCenter RW Boolean Whether form is autocentered
BufferMode RW Numeric Buffer mode
Caption RW Character Text displayed in caption
Closable RW Boolean Whether form is closable
ControlCount R Numeric Number of controls in form
CurrentX RW Numeric Current x coordinate for the next drawing method
CurrentY RW Numeric Current y coordinate for the next drawing method
DrawWidth RW Numeric Line width in pixels for draw operations
ExitOnClose RW Boolean Whether to exit session on closing form
FillColor RW Numeric or Character Fill color
FillStyle RW Numeric Fill style setting
KeyPreview RW Boolean Whether keypreview is enabled
MaxButton RW Boolean Whether form has a maximize button
Menubar RW Boolean Whether form has a menubar. From v8.0.
MenubarLayout RW Character Menubar specification: "Opt1(Sub1,Sub2,Sub3),Opt2(Sub4,Sub5),...".
From v8.0.
Message RW Character Text displayed in statusbar
MinButton RW Boolean Whether form has a minimize button
MobileFullScreen RW Boolean Whether when the form is running on a phone, it is maximized into the phone viewport with its border removed.
MousePointer RW Numeric Mouse pointer: 0 = arrow, 1 = arrow, 2 = cross, 3 = I-beam, 5 = size, 6 = NE/SW, 7 = size N/S, 8 = size NW/SE, 9 = size W/E, 10 = up arrow, 12 = no drop, 15 = pointing hand
Picture RW Character Filename of background image
Scrollbars RW Numeric Scrollbars: 0 = none, 1 = horizontal, 2 = vertical, 3 = both
ShowTips RW Boolean Whether tooltips are shown for controls in the form
Statusbar RW Boolean Whether form has a statusbar
Titlebar RW Boolean Whether form has a titlebar
Toolbar RW Boolean Whether form has a toolbar. From v8.0.
ToolbarLayout RW Character Toolbar specification: "icon@Caption,icon@Caption,...". From v8.0.
ToolbarPosition RW Character Toolbar position: left | right | top | bottom. From v8.0.
WindowState RW Numeric Window state: 0 = normal, 1 = minimized, 2 = maximized, 3 = fullscreen/kiosk
WindowType RW Numeric Window type: 0 = modeless, 1 = modal

Methods

This class supports the Common Methods plus the following:

Method Args Description
AddObject existing as Object | newobject as Character, class as Character Add an existing object or a new object, in which case the object's class must also be specified
Box x as Numeric, y as Numeric[, x2 as Numeric, y2 as Numeric] Draw a box from currentx, currenty to x, y. If x2 and y2 are specified, draw a box from x, y to x2, y2
Circle radius as Numeric[, x as Numeric, y as Numeric] Draw a circle with the specified radius at currentx, currenty. If x and y are specified, draw the circle at x, y
Clear None Clear the form
Close None Close the form
Controls control as Numeric Return an object reference to the specified control within the form
Draw None Repaint form
get id as Character Reference the form UI element with the specified id. Synonym of getElementByID().
From v8.0.
getElementByID id as Character Reference the form UI element with the specified id. Synonym of get(). From v8.0.
HideMessage None Hide any system message currently displayed in the form. From v7.0.
Line x as Numeric, y as Numeric[, x2 as Numeric, y2 as Numeric] Draw a line from currentx, currenty to x, y. If x2 and y2 are specified, draw a line from x, y to x2, y2
Print text as Character Print the specified text in the form
printObjectTree None Print the form object tree, example output:
form::form [visible=0, height=700, width=700]
    mycontainer5::container [visible=0, height=480, width=640]
        myheader5::label [visible=0, height=40, width=156]
        grid5::grid [visible=0, height=192, width=256]

From v8.0.

Release None Release form
RemoveObject existing as Object Remove the specified object
Show [WindowType as Numeric] Show the form. WindowType 0 = modeless, 1 = modal
ShowDropDown controlID as Character[, width as Numeric[, height as Numeric]] Show the Form as a drop down from the specified controlID UI control. Optionally specify the width and height of the drop down. If these are not specified, the width will adjust to width of the controlID UI control and the height defaults to 250 pixels. The drop down can be closed by pressing the Esc key or issuing a form.close(). (From Lianja v3.3).
ShowErrorMessage text as Character Display the specified text in a red system message at the top of the form. From v7.0.
ShowInfoMessage text as Character Display the specified text in a blue system message at the top of the form. From v7.0.
ShowMessage text as Character Display the specified text in a blue system message at the top of the form. From v7.0.
ShowSuccessMessage text as Character Display the specified text in a green system message at the top of the form. From v7.0.
ShowWarningMessage text as Character Display the specified text in a blue system message at the top of the form. From v7.0.
TextHeight None Return current text height setting in pixels
TextWidth text as Character Return pixels required to display specified text

Events

This class supports the Common Events plus the following:

Event Args Description
actionbarclick actioncaption as Character Occurs when an icon in the form actionbar is clicked. From v8.0.
afterclose None Occurs after the form is closed.
beforeclose None Occurs when the form is being closed.
initform None Occurs when the form is initialized. From v8.0.
load None Occurs before the form is activated
menubarclick menucaption as Character Occurs when an option in the form menubar is clicked. From v8.0.
moved x as Numeric, y as Numeric,
width as Numeric, height as Numeric
Occurs when the form is moved or resized. From v7.0.
toolbarclick toolcaption as Character Occurs when an icon in the form toolbar is clicked. From v8.0.