#Align

C
'This class provides constants for alignment of text, cells...
Normal
C
i
0
Left
C
i
1
Right
C
i
2
Center
C
i
3
TopNormal
C
i
16
TopLeft
C
i
17
TopRight
C
i
18
Top
C
i
19
BottomNormal
C
i
32
BottomLeft
C
i
33
BottomRight
C
i
34
Bottom
C
i
35
IsLeft
M
b
(Alignment)i
IsRight
M
b
(Alignment)i
IsCenter
M
b
(Alignment)i
IsTop
M
b
(Alignment)i
IsBottom
M
b
(Alignment)i
IsMiddle
M
b
(Alignment)i
#Application

C
ActiveControl
R
WebControl

#Arrange

C
'This class provides the constants that define the arrangement mode of a container.
None
C
i
0
'This constant is used when a container does not arrange its contents.
Vertical
C
i
1
'This constant is used for a vertical arrangement.
Horizontal
C
i
2
'This constant is used for an horizontal arrangement.
Row
C
i
3
'This constant is used for arranging controls in rows.
Column
C
i
4
'This constant is used for arranging controls in columns.
#Color

CO
'This class provides constant for pre-defined colors and color-related methods
Default
C
i
-1
Transparent
C
i
-16777216
Black
C
i
0
White
C
i
16777215
Gray
C
i
8421504
LightGray
C
i
12632256
DarkGray
C
i
4210752
Blue
C
i
255
DarkBlue
C
i
128
SoftBlue
C
i
8421631
Green
C
i
65280
DarkGreen
C
i
32768
SoftGreen
C
i
8454016
Red
C
i
16711680
DarkRed
C
i
8388608
SoftRed
C
i
16744576
Cyan
C
i
65535
DarkCyan
C
i
32896
SoftCyan
C
i
8454143
Magenta
C
i
16711935
DarkMagenta
C
i
8388736
SoftMagenta
C
i
16744703
Pink
C
i
16744703
Yellow
C
i
16776960
DarkYellow
C
i
8421376
SoftYellow
C
i
16777088
Orange
C
i
16744448
DarkOrange
C
i
8404992
SoftOrange
C
i
16760960
Violet
C
i
8388863
DarkViolet
C
i
4194432
SoftViolet
C
i
12615935
Royal
C
i
33023
DarkRoyal
C
i
16512
SoftRoyal
C
i
8438015
Purple
C
i
16711808
DarkPurple
C
i
8388672
SoftPurple
C
i
16744640
SetAlpha
M
i
(Color)i(Alpha)i
'Change the alpha component of a color and return it.
RGB
M
i
(Red)i(Green)i(Blue)i[(Alpha)i]
'Returns a color value from its red, green, blue and alpha components.
'
'If ~Alpha~ is not specified, then it is assumed to be zero, i.e. you get a fully opaque color.
'
'[[ info
'In Gambas, the alpha value of fully opaque colors is zero, and the alpha value of fully transparent colors is 255.
']]
ToHTML
M
s
(Color)i
'Convert a gambas colour integer into HTML CSS compliant code.
'
'The resulting string will be either a hash prefixed hex value. eg. '#00FF00' that can be used anywhere or an rgba() string with integer values if alpha (transparency) is set. eg. 'rgba(0,128,255,0.75)' that should only be used in css **style** assignments.
'
#Key

C
Shift
R
b

Control
R
b

Alt
R
b

Meta
R
b

Normal
R
b

Code
R
s

Text
R
s

Shortcut
R
s

_Event
V
Collection

_ShortcutToDOM
M
s
(sShortcut)s
#Message

C
_call
M
i
(Text)s[(Button)s]
Info
M
i
(Text)s[(Button)s]
Warning
M
i
(Text)s[(Button1)s(Button2)s(Button3)s]
Error
M
i
(Text)s[(Button)s]
Question
M
i
(Text)s[(Button1)s(Button2)s(Button3)s]
#Mouse

C
X
R
i

Y
R
i

ScreenX
R
i

ScreenY
R
i

Button
R
i

Left
R
b

Middle
R
b

Right
R
b

StartX
R
i

StartY
R
i

_Define
M

(sType)s(cEvent)Collection;
#Paint

C
Device
R
WebControl

Brush
P
PaintBrush

W
P
i

Width
P
i

H
P
i

Height
P
i

LineWidth
P
f

LineCap
P
i

LineJoin
P
i

MiterLimit
P
f

LineDash
P
Float[]

Dash
P
Float[]

LineDashOffset
P
f

DashOffset
P
f

Operator
P
i

OperatorOver
C
i
0
OperatorIn
C
i
1
OperatorOut
C
i
2
OperatorATop
C
i
3
OperatorDestOver
C
i
4
OperatorDestIn
C
i
5
OperatorDestOut
C
i
6
OperatorDestATop
C
i
7
OperatorAdd
C
i
8
OperatorSource
C
i
9
OperatorXor
C
i
10
LineCapButt
C
i
0
LineCapRound
C
i
1
LineCapSquare
C
i
2
LineJoinMiter
C
i
0
LineJoinRound
C
i
1
LineJoinBevel
C
i
2
Begin
M

(Device)WebControl;
End
M


Save
M


Restore
M


Rectangle
M

(X)f(Y)f(Width)f(Height)f
Fill
M

[(Style)v(Preserve)b]
Stroke
M

[(Style)v(Preserve)b]
MoveTo
M

(X)f(Y)f
LineTo
M

(X)i(Y)i
Arc
M

(XC)f(YC)f(Radius)f[(Angle)f(Length)f]
Ellipse
M

(X)f(Y)f(Width)f(Height)f[(Angle)f(Length)f]
CurveTo
M

(X1)f(Y1)f(X2)f(Y2)f(X3)f(Y3)f
NewPath
M


ClosePath
M


Clip
M

[(Preserve)b]
LinearGradient
M
PaintBrush
(X1)f(Y1)f(X2)f(Y2)f(Colours)Variant[];(Positions)Float[];
RadialGradient
M
PaintBrush
(X1)f(Y1)f(R1)f(X2)f(Y2)f(R2)f(Colours)Variant[];(Positions)Float[];
Color
M
PaintBrush
(Color)v
DrawImage
M

(Image)s(X)f(Y)f[(Width)f(Height)f(Opacity)f(Source)Rect;]
Translate
M

(TX)f(TY)f
Rotate
M

(Angle)f
Scale
M

(SX)f[(SY)f]
Reset
M


#PaintBrush

C
_Color
p
v

_Image
p
s

_Gradient
p
Gradient

_Type
r
i

_new
m


#Scroll

C
'Constants used by the ScrollBar property of many controls.
None
C
i
0
'No scrollbar is visible.
Horizontal
C
i
1
'The horizontal scrollbar is visible if needed.
Vertical
C
i
2
'The vertical scrollbar is visible if needed.
Both
C
i
3
'Both horizontal and vertical scrollbars are visible if needed.
#Select

C
'Constants used for the selection mode of WebTable control.
None
C
i
0
'No selection is possible.
Single
C
i
1
'Only one element can be selected.
Multiple
C
i
2
'Many elements can be selected at the same time.
#Session

C
Type
P
s

Id
P
s

Timeout
P
f

Prefix
P
s

Unique
P
b

Modified
P
b

CookiePath
P
s

CookieName
P
s

Keys
R
String[]

Size
R
l

Path
R
s

User
P
s

_init
M


_SendCookie
M


_exit
M


Create
M
s

Abandon
M


_get
M
v
(Key)s
Exist
M
b
(Key)s
_put
M

(Value)v(Key)s
Save
M


Load
M


#WebAudio
WebControl
C
_IsControl
C
b
T
_IsVirtual
C
b
T
_Properties
C
s
"*,-Class,-Width,-Height,-Visible,-Expand,-Ignore,-Enabled,Audio{WebAudio},Tracking,Loop,AutoPlay,Sources"
_Group
C
s
"Special"
_DefaultEvent
C
s
"Ready"
:Ready
:


'Triggers when a file is ready to play.
:End
:


'Triggers when the audio has finished playing.
:Pause
:


'Triggers when the audio pauses.
:Position
:


'Triggers as audio position changes during play.
Audio
p
s

'The URL / path of the audio to play.
Loop
p
b

'The audio will repeat.
AutoPlay
p
b

'Autoplay the audio on loading.
Sources
p
String[]

'A list of alternative sources to try.
'
'The mimetype of a source is deducted from the file extension.
'
'### Example
'[[ code gambas
'WebAudio1.Sources = ["/mp3/track.mp3"]
'WebAudio1.Sources = ["/ogg/track.ogg"]
']]
Paused
p
b

'Get or set if the audio is paused
Duration
r
f

'Length of the loaded track.
Length
r
f

'Length of the loaded track.
Position
p
f

'Get or set track position.
Pos
p
f

'Get or set track position.
Tracking
p
b

'Return or set if the Position property is updated in real time.
_BeforeRender
m


_Render
m


PrintSources
m


_UpdateProperty
m

(sProp)s(vValue)v
_AfterRender
m


Play
m


Pause
m


Stop
m


#WebButton
WebControl
C
'This class implements a push button.
_Properties
C
s
"*,Border=True,Text,Image{WebImage},Immediate,ShowArrow,Default,Cancel"
_DefaultEvent
C
s
"Click"
_DefaultSize
C
s
"16,4"
:Click
:


'This event is raised when the button is pressed.
'
'### See also
'[../immediate]
:Menu
:


'This event is raised when the button is pressed.
'
'### See also
'[../immediate]
Text
p
s

'Return or set the button text.
Image
p
s

'Return or set the button image relative path.
Immediate
p
b

'If the Immediate property is set, the [../click] event is raised to generate javascript code that will be executed on the client side when
'the button is clicked.
'
'In that case, the Click event handler should only call methods that generate javascript on the client side:
'- [../../webform/exec](WebForm.Exec)
'- [../../webtextbox/copy](WebTextBox.Copy)
'- ...
ShowArrow
p
b

'Return or set if the button displays an arrow
Default
p
b

Cancel
p
b

_RenderStyleSheet
m


_BeforeRender
m


_Render
m


_AfterRender
m


Click
m


'Click on the button.
#WebCheckBox
WebControl
C
'This class implements a check-box control.
_Properties
C
s
"*,Text,Value"
_DrawWith
C
s
"CheckBox"
_DefaultSize
C
s
"24,4"
_Similar
C
s
"WebButton"
_DefaultEvent
C
s
"Click"
:Click
:


'This event is raised when the check-box is toggled.
Value
p
b

'Return or set if the control is checked.
Checked
p
b

'Return or set if the control is checked.
Text
p
s

'Return or set the text displayed beside the check mark.
_Render
m


_UpdateProperty
m

(sProp)s(vValue)v
#WebComboBox
WebControl
C
'This class implements a combo-box control.
_Properties
C
s
"*,Border=True,ReadOnly=True,PlaceHolder,Text,List"
_DrawWith
C
s
"ComboBox"
_DefaultSize
C
s
"24,4"
_Similar
C
s
"WebTextBox"
_DefaultEvent
C
s
"Click"
:Click
:


'This event is raised when an item is selected in the list box.
:Change
:


'This event is raised when the combo-box text has changed. Works only if the combo-box is editable.
:Activate
:


'This event is raised when the ENTER key is hit. Works only if the combo-box is editable.
Text
p
s

'Return or set the combo-box text.
Count
r
i

'Return the number of items in the combo-box popup.
Index
p
i

'Return or set the index of the current selected item.
List
p
String[]

'Return or set the contents of the combo-box popup as a string array.
ReadOnly
p
b

'Return or set if the combo-box is read-only, i.e. not editable.
PlaceHolder
p
s

'Return or set the placeholder text displayed when the editable combo-box is empty.
_new
m


'Create a new WebComboBox control.
_BeforeRender
m


_Render
m


_UpdateProperty
m

(sProp)s(vValue)v
Clear
m


'Clear the contents of the combo-box and its popup.
Add
m

(Item)s[(Index)i]
'Add an item to the popup list.
'
'- ~Item~ is the text of the item to add.
'- ~Index~ is the position the item will be inserted from. If not specified, the item is added at the end of the popup list.
Remove
m

(Index)i
'Remove an item from the popup list.
'
'- ~Index~ is the index of the item to remove, between 0 and [../count] - 1.
#WebContainer
WebControl
C
'This class implements a generic container for other controls.
'
'It is also the parent class of every other container.
_IsContainer
C
b
T
_Group
C
s
"Container"
_Properties
C
s
"*,Arrangement{Arrange.*},Margin,Spacing,Indent,Border"
_DefaultArrangement
C
s
"F"
_DefaultSize
C
s
"32,32"
Arrangement
p
i

'Return or set the how the container arrange its contents.
'
'The value of that property can be one of the value of the [../arrange] class.
Margin
p
b

'Return or set if there is a margin between the container border and all its children.
'
'The margin size is 0.5em.
Spacing
p
b

'Return or set if the children of the container are spaced out.
'
'The amount of space is 0.5em.
Border
p
b

'Return or set if the container has a border.
Indent
p
b

'Return or set if the children controls of the container are indented.
'
'The direction of the indentation follows the direction of the container arrangement.
'
'The amount of indentation is 0.5em.
Children
r
WebControl[]

'Return an array of all container's children.
_Container
v
WebContainer

_Add
m

(hChild)WebControl;
_Remove
m

(hChild)WebControl;
_UpdateChildName
m

(sOld)s(sNew)s
_IsFirstVisibleChild
m
b
(hChild)WebControl;
_Render
m


_RenderStyleSheet
m


_RefreshReply
m
b

_CancelChildrenRefresh
m


_SetContainer
m

(hCont)WebContainer;
_Raise
m

(sName)s
_Lower
m

(sName)s
DeleteChildren
m


'Delete all container's children.
Delete
m


'Delete the container with all its children.
HasChildren
m
b

#WebControl


'This class is the parent class of every web controls.
_Invalid
v
b

_IsControl
C
b
T
_Properties
C
s
"Class,Width{WebCoord},Height{WebCoord},Visible=True,Enabled=True,Tag,Expand,Ignore,Background{Color},Foreground{Color},Tooltip,Font{WebFont}"
_Family
C
s
"WebForm"
_DefaultEvent
C
s
"Render"
:Render
:


'This event is raised just after the rendering of the control, so that you can add your own HTML contents.
:KeyPress
:


'This event is raised when a keyboard key is pressed while the control has the focus.
:Enter
:


'This event is raised when the mouse cursor enters the control.
:Leave
:


'This event is raised when the mouse cursor leaves the control.
Id
r
i

'Return the server control identifier.
Name
p
s

'Return or set the name of the control, used as an identifier on the client side.
Tag
p
v

'Returns or sets the control tag.
'
'This property is intended for the programmer and is never used by the component. It can contain any [/lang/type/variant] value.
Parent
r
WebContainer

'Return the parent container of the control.
Expand
p
b

'Return or set if the control should expand its size according to its parent arrangement mode.
Visible
p
b

'Return or set if the control is visible.
Style
r
WebControlStyle

'Return a virtual object that allows to define specific style sheet elements of the control.
Form
r
WebForm

'Return the web form that control belongs to.
Width
p
s

'Return or set the explicit width of the control.
'
'This property can take any valid CSS size. If not set, the control will have its default width.
W
p
s

'Return or set the explicit width of the control.
'
'This property can take any valid CSS size. If not set, the control will have its default width.
Height
p
s

'Return or set the explicit height of the control.
'
'This property can take any valid CSS size. If not set, the control will have its default height.
H
p
s

'Return or set the explicit height of the control.
'
'This property can take any valid CSS size. If not set, the control will have its default height.
Ignore
p
b

'Return or set if the control must be ignored by its parent container in automatic arrangement mode.
Enabled
p
b

'Return or set if the control is enabled.
Background
p
i

'Return or set the background color of the control.
Foreground
p
i

'Return or set the foreground color of the control.
Border
p
b

'Return or set if the control has a border.
Class
p
s

'Return or set the specific CSS classes added to the control.
Tooltip
p
s

'Return or set the tooltip displayed when the mouse cursor hovers the control.
Font
p
s

'Return or set the specific font of the control.
_NextName
V
s

_Shortcuts
V
Collection

_RefreshJavascript
V
Collection

_Refresh
v
b

_EventName
v
s

_Proxy
v
s

_NoRefresh
v
i

_Naked
v
b

_new
m

[(Parent)WebContainer;]
'Create a new [@{class}](.).
_attach
m

(Parent)o(EventName)s
_PrintNeedKeyPress
M

[(bForce)b]
_SetForm
m

(hForm)WebForm;
FromId
M
WebControl
(Id)i
'Return a WebControl from its identifier.
FromName
M
WebControl
(Name)s
'Return a WebControl from its name.
Raise
m


'Raise the control.
Show
m


'Show the control.
'
'Setting the [../visible] property to TRUE has the same effect.
_GetClassId
m
s
[(sClass)s]
_GetEventJS
m
s
(sProp)s(sEvent)s[(sArg)s(sMore)s]
_BeforeRender
m


_RenderStyleSheet
m


_Render
m


_AfterRender
m


_StartStyleSheet
m


_AddStyleSheet
m

(sStyle)s
ToHTML
m
s

_EndStyleSheet
m


_RemoveStyleSheet
m

(sStyle)s
Refresh
m


'Refresh the control.
IsHidden
m
b

'Return if the control or one of its parent is hidden.
_CanRefreshDyn
m
b

_CanRefresh
m
b

_CancelChildrenRefresh
m


_CancelRefresh
m


_RefreshReply
m
b

_Redraw
m


_GetUpdateJS
m
s
(sEvent)s(sProp)s[(sGetValue)s(sMore)s]
_GetUpdateWaitJS
m
s
(sEvent)s(sProp)s[(sGetValue)s(sMore)s]
_AddRefresh
m

(sJavascript)s
SetFocus
m

[(Highlight)b]
'Set the focus on the control.
'
'- ~Highlight~ is an optional argument that specify if the control contents must be highlighted. It usually works only for TextBox or TextArea controls.
Lower
m


'Lower the control.
_GetNames
M
s

Delete
m


'Delete the control
Hide
m


'Hide the control.
'
'Setting the [../visible] property to FALSE has the same effect.
_GetLink
M
s
(sLink)s
_GetImageLink
M
s
(sImage)s
AddClass
m

(Class)s
'Add a specific class to the [../class] property.
RemoveClass
m

(Class)s
'Remove a specific class from the [../class] property.
_UpdateProperty
m

(sProp)s(vValue)v
_RaiseKeyPress
m
b
(cEvent)v
_RegisterShortcut
m

(sShortcut)s(sPrevious)s
_GetTopLevel
m
WebForm

_SetCurrentCell
M

[(hCtrl)WebControl;(sCell)s]
_RaiseMouseEvent
m

(sEvent)s(cEvent)v
#WebControlStyle

C
_Style
v
Collection

_get
m
s
(Property)s
_put
m

(Value)s(Property)s
IsVoid
m
b

Exist
m
b
(Property)s
_GetStyleSheet
m
String[]

#WebDateBox
WebControl
C
_Properties
C
s
"*,Border=True,ReadOnly=True,DateTime"
_Group
C
s
"Chooser"
_DrawWith
C
s
"ComboBox"
_DefaultSize
C
s
"24,4"
_Similar
C
s
"WebTextBox"
_DefaultEvent
C
s
"Click"
:Click
:


:Change
:


Text
p
s

Date
p
d

Value
p
d

ReadOnly
p
b

DateTime
p
b

_new
m


_Render
m


_UpdateProperty
m

(sProp)s(vValue)v
Clear
m


#WebDateChooser
WebContainer
C
'This class implements a calendar that allows to choose a date.
_IsContainer
C
b

_Group
C
s
"Chooser"
_Properties
C
s
"*,Value,Border"
_DrawWith
C
s
"DateChooser"
:Change
:


'This event is raised when the selected date has changed.
:Click
:


'This event is raised when a date has been selected by the user.
Value
p
d

'Return or set the selected date.
_new
m


'Create a new WebDateChooser control.
Delete
m


panCalendar_Render
m


cmbMonth_Click
m


txtYear_Change
m


btnPrev_Click
m


btnNext_Click
m


_UpdateProperty
m

(sProp)s(vValue)v
#WebDrawingArea
WebControl
C
_Properties
C
s
"*,Border"
_DrawWith
C
s
"DrawingArea"
_DefaultEvent
C
s
"Draw"
_Width
v
i

_Height
v
i

:Draw
:


'This event is raised when the DrawingArea contents must be drawn.
:MouseDown
:


'This event is raised when a mouse button is pressed while the mouse cursor is inside the control.
:MouseUp
:


'This event is raised when a mouse button is released.
'
'It is always raised for the control that triggered the corresponding [../.mouseup] event.
:MouseMove
:


'This event is raised when the mouse cursor moves.
_new
m


_Render
m


_UpdateProperty
m

(sProp)s(vValue)v
Refresh
m


#WebFileButton
WebControl
C
'This class implements a file selector button.
_Properties
C
s
"*,Border=True,Text,Image{WebImage}"
_DefaultEvent
C
s
"Click"
_DefaultSize
C
s
"16,4"
:Click
:


'This event is raised when the button is pressed.
:Progress
:


'This event is raised when the button is pressed.
:Finish
:


'This event is raised when the button is pressed.
:Abort
:

(Reason)s
'This event is raised when the button is pressed.
Text
p
s

'Return or set the button text.
Image
p
s

'Return or set the button image relative path.
File
r
s

'Return the name of the selected file.
Progress
r
f

'Return the upload progression as a number between 0 and 1.
Path
r
s

'Return the path of the uploaded file on the disk
Enabled
p
b

_BeforeRender
m


_Render
m


_AfterRender
m


Upload
m


Abort
m


_Finish
m


_Abort
m

(sErr)s
_UpdateProperty
m

(sProp)s(vValue)v
#WebForm
WebContainer
CA
'This class represents the different pages and dialogs of your Web application.
Debug
P
b

_IsForm
C
b
T
_HiddenControls
C
s
"WebControl,WebForm,Timer,WebMenu"
_Properties
C
s
"*,Title,Resizable,Persistent,Shortcuts"
_DefaultEvent
C
s
"Open"
Current
P
WebForm

'Return or set the current form, i.e. the main form of the application that fills the web page.
'
'If the current form changes, the web page is automatically reloaded.
:Open
:


'This event is raised when the form is opened.
:Event
:


'This event is raised each time an event is handled by the form.
:Close
:


'This event is raised when the form is closed.
Title
p
s

'This title is used as HTML page title if the form is the main form.
Resizable
p
b

'Return or set if the form is resizable when used as a dialog.
Width
p
s

'Return or set the minimum width of the form.
'
'This property can take any valid CSS size. If not set, the control will have no minimum width.
W
p
s

'Return or set the minimum width of the form.
'
'This property can take any valid CSS size. If not set, the control will have no minimum width.
Height
p
s

'Return or set the minimum height of the form.
'
'This property can take any valid CSS size. If not set, the control will have no minimum height.
H
p
s

'Return or set the minimum height of the form.
'
'This property can take any valid CSS size. If not set, the control will have no minimum height.
Popup
r
b

'Return if the form is a popup.
PopupParent
r
WebControl

'Return the control that owns the popup.
Persistent
p
b

'Return or set if the form is persistent.
'
'Closing a non-persistent form automatically destroys it.
Shortcuts
p
String[]

_DisableRefresh
V
i

_HasRefresh
V
b

_InMessage
V
i

_CurrentPopup
V
WebForm

_CurrentModal
V
WebForm

_Loaded
v
b

_Window
v
i

_init
M


PrintLog
M

(sLog)s
Main
M


Application_Signal
M

(Num)i
Timeout_Timer
M


_AddJavascript
M

(sStr)s
_AddJavascriptBefore
M

(sStr)s
_HandleMessage
m


Render
m


_new
m


Hide
m


'Hide the form.
_ready
m


_BeforeRender
m


_AddPreload
M

(sLink)s
_GetJavascriptFiles
m
String[]

_GetJavascriptExternFiles
m
String[]

AddJavascriptFile
m

(sFile)s
'Add a javascript file to the list of javascript ressources defined by the `<style>` markups of the page header.
_UpdateProperty
m

(sProp)s(vValue)v
_RaiseKeyPress
m
b
(cEvent)v
Print
M

(Text)s
'Print some text to the browser javascript console.
Exec
M

(Javascript)s
'Execute some javascript into the browser.
_BeginJavascript
m
v

_EndJavascript
m

(vSave)v
Delete
m


Close
m

[(ReturnValue)v]
'Close the form.
'
'If the form was a dialog or a popup, you can specify a return value with the optional ~ReturnValue~ argument.
'
'This is the value that will be returned by the [../showmodal] or [../showpopup] method.
Show
m


'Show the form.
_GetWindowContainer
m
WebContainer

Move
m

(X)s(Y)s[(Width)s(Height)s]
'Move and/or resize the form.
'[[ warning
'A main form cannot be moved nor resized.
']]
ShowModal
m
v
[(Parent)WebControl;]
'Show the form as a modal dialog.
'
'~Parent~ is the owner of the dialog. If not specified, then the value of [/lang/last] is used as owner.
'
'An error is raised if you try to call this method on an embedded form.
ShowPopup
m
v
(Control)WebControl;
'Show the form as a popup.
'
'- ~Control~ is the owner of the popup. It is normally the control the popup is attached to.
Resize
m

(Width)s(Height)s
'Resize the form.
'[[ warning
'A main form cannot be resized.
']]
Application_Error
M


Reload
m


'Reload the form.
'
'It the form is not a main form, then it is refreshed.
Goto
M

(Form)WebForm;
'Change the current main form.
'
'It is equivalent to set the [../current] property.
_GetMenuBar
m
WebMenuBar

AddHeader
m

(Header)s
_GetHeaders
m
String[]

_GetDefault
m
i

_SetDefault
m

(hCtrl)WebControl;
_GetCancel
m
i

_SetCancel
m

(hCtrl)WebControl;
_GetActiveControl
M
WebControl

#WebHBox
WebContainer
C
'A container that lays out its content horizontally.
_Properties
C
s
"*,-Arrangement"
_DefaultArrangement
C
s
"H"
_Similar
C
s
"WebContainer"
_new
m


#WebHtml
WebControl
C
_Properties
C
s
"*,Text,Border"
_DrawWith
C
s
"TextLabel"
Html
p
s

Text
p
s

_new
m


_Render
m


#WebImage
WebControl
C
_Properties
C
s
"*,Border,Image{WebImage},Mode{WebImage.*}=Normal,Alignment{Align.*}=Normal"
Normal
C
i
0
Fill
C
i
1
Cover
C
i
2
Contain
C
i
3
Repeat
C
i
4
Image
p
s

Mode
p
i

Alignment
p
i

_new
m


_RenderStyleSheet
m


_Render
m


#WebLabel
WebControl
C
_Properties
C
s
"*,Text,Alignment{Align.Normal;Left;Right;Center}=Normal,Border"
_DrawWith
C
s
"Label"
_DefaultSize
C
s
"24,4"
Text
p
s

Alignment
p
i

_new
m


_Render
m


_RenderStyleSheet
m


#WebListBox
WebControl
C
_Properties
C
s
"*,Border=True,List,Text,Mode{Select.*}=Single,UseHTML"
_Group
C
s
"View"
_DrawWith
C
s
"ListBox"
_DefaultSize
C
s
"24,4"
_Similar
C
s
"WebTextBox"
_DefaultEvent
C
s
"Click"
:Click
:


'This event is raised when an item is clicked in the list box.
:Activate
:


'This event is raised when an item is clicked twice.
:Select
:


'This event is raised when the selection changes.
Mode
p
i

'Return the listbox selection mode.
Text
p
s

'Return or set the text of the current selected item.
Count
r
i

'Return the number of items in the combo-box popup.
Index
p
i

'Return or set the index of the current selected item.
Current
p
i

'Return or set the index of the current selected item.
List
p
String[]

'Return or set the contents of the combo-box popup as a string array.
Selection
r
Integer[]

'Return the list of selected items.
UseHTML
p
b

'Return or set if the items are HTML or plain text.
ScrollX
p
i

ScrollY
p
i

_new
m


Select
m

(Row)i[(Length)i]
_RenderStyleSheet
m


_BeforeRender
m


_Render
m


IsSelected
m
b
(Row)i
_UpdateProperty
m

(sProp)s(vValue)v
Unselect
m

(Row)i[(Length)i]
UnselectAll
m


Clear
m


SelectAll
m


Add
m

(Item)s[(Index)i]
'Add an item to the list.
'
'- ~Item~ is the text of the item to add.
'- ~Index~ is the position the item will be inserted from. If not specified, the item is added at the end of the popup list.
Remove
m

(Index)i
'Remove an item from the list.
'
'- ~Index~ is the index of the item to remove, between 0 and [../count] - 1.
#WebMenu
WebContainer
C
_Group
C
s
"Container"
_Properties
C
s
"*,-Arrangement,-Margin,-Spacing,-Border,Text,Image{WebImage},Shortcut"
_DefaultArrangement
C
s
"V"
_DefaultEvent
C
s
"Click"
:Click
:


Text
p
s

Title
p
s

Image
p
s

Shortcut
p
s

_BeforeRender
m


_Render
m


_UpdateProperty
m

(sProp)s(vValue)v
Popup
m
b
(Control)WebControl;
#WebProgressBar
WebControl
C
_Properties
C
s
"*,Label=True,Border=True"
_DefaultSize
C
s
"24,4"
_DrawWith
C
s
"ProgressBar"
Label
p
b

Value
p
f

_Render
m


#WebRadioButton
WebControl
C
_Properties
C
s
"*,Text,Value"
_DrawWith
C
s
"RadioButton"
_DefaultSize
C
s
"24,4"
_Similar
C
s
"WebButton"
_DefaultEvent
C
s
"Click"
:Click
:


Value
p
b

Checked
p
b

Text
p
s

_Render
m


_UpdateProperty
m

(sProp)s(vValue)v
#WebScrollView
WebContainer
C
_Similar
C
s
"WebContainer"
_Properties
C
s
"*,ScrollBar{Scroll.*}=Both"
_DrawWith
C
s
"ScrollView:Border=False"
:Scroll
:


ScrollX
p
i

ScrollY
p
i

ScrollBar
p
i

Scroll
m

(X)i(Y)i
_new
m


_Render
m


EnsureVisible
m

(Child)WebControl;
_UpdateProperty
m

(sProp)s(vValue)v
SetHeaders
m

(Horizontal)WebScrollView;(Vertical)WebScrollView;
#WebSeparator
WebControl
C
_Properties
C
s
"*"
_DrawWith
C
s
"Separator"
_DefaultSize
C
s
"24,4"
_Render
m


#WebSlider
WebSpinBox
C
_DrawWith
C
s
"Slider"
_DefaultSize
C
s
"24,4"
_BeforeRender
m


#WebSpinBox
WebControl
C
_Properties
C
s
"*,Border=True,MinValue=0,MaxValue=100,Step=1,Value=0"
_DrawWith
C
s
"SpinBox"
_DefaultSize
C
s
"24,4"
_DefaultEvent
C
s
"Change"
:Change
:


Value
p
i

MinValue
p
i

MaxValue
p
i

Step
p
i

Text
r
s

_BeforeRender
m


_AfterRender
m


_UpdateProperty
m

(sProp)s(vValue)v
#WebTabPanel
WebContainer
C
_Properties
C
s
"*,Border=True,Count{Range:1;256}=1,Index,Text,ShowTabs=True"
_IsMultiContainer
C
b
T
_DrawWith
C
s
"TabPanel"
_DefaultEvent
C
s
"Click"
:Click
:


Count
p
i

Text
p
s

Index
p
i

ShowTabs
p
b

Border
p
b

_new
m


Delete
m


Remove
m

(Index)i
_Render
m


_RenderStyleSheet
m


_UpdateProperty
m

(sProp)s(vValue)v
#WebTable
WebControl
C
_Properties
C
s
"*,Border=True,Mode{Select.*}=None,ShowCheck=True,Header{WebTable.None;Horizontal;Vertical;Both}=Horizontal,Sortable"
_Group
C
s
"View"
_DrawWith
C
s
"GridView"
_DefaultSize
C
s
"24,24"
_DefaultEvent
C
s
"Data"
None
C
i
0
Horizontal
C
i
1
Vertical
C
i
2
Both
C
i
3
:Data
:

(Row)i(Column)i(Data)WebTableData;
:Select
:


:Activate
:


:Sort
:


:Click
:

(Row)i(Column)i
'This event is raised when a control [embedded in a cell](../../webtabledata/control) raises its 'Click' event.
Columns
r
_WebTableColumns

Count
p
i

Max
r
i

Mode
p
i

Selection
r
Integer[]

Current
p
i

Display
p
i

Step
p
i

ScrollX
p
i

ScrollY
p
i

ShowCheck
p
b

Header
p
i

ShowHeader
p
b

Sortable
p
b

SortColumn
p
i

SortOrder
p
i

_new
m


Select
m

(Row)i[(Length)i]
IsSelected
m
b
(Row)i
_Render
m


UnselectAll
m


SelectAll
m


Unselect
m

(Row)i[(Length)i]
_UpdateProperty
m

(sProp)s(vValue)v
_IsEverythingSelected
m
b

Clear
m


AddColumn
m
_WebTableColumn
(Text)s[(Width)s(Alignment)i]
EnsureVisible
m

(Row)i
_RaiseCellEvent
m

(sCell)s(sEvent)s(aArg)Variant[];
#WebTableData

C
'This class allows to define the contents of a WebTable cell through its [../webtable/.data] event.
Text
v
s

'Return or set the text displayed in the cell.
Html
v
s

'Return or set the HTML contents of the cell.
Background
v
i

'Return or set the background color of the cell.
Foreground
v
i

'Return or set the foreground color of the cell.
Control
v
WebControl

'Setting this property will embed a duplicated version of the control into the cell.
#WebTextArea
WebControl
C
_Properties
C
s
"*,Border=True,ReadOnly,Wrap,PlaceHolder,Text"
_DrawWith
C
s
"TextArea"
_DefaultSize
C
s
"16,16"
:Change
:


Text
p
s

ReadOnly
p
b

Wrap
p
b

PlaceHolder
p
s

_RenderStyleSheet
m


_BeforeRender
m


_Render
m


_AfterRender
m


_UpdateProperty
m

(sProp)s(vValue)v
Clear
m


Copy
m


#WebTextBox
WebControl
C
_Properties
C
s
"*,Border=True,ReadOnly,PlaceHolder,Text,Password,ShowClear"
_DrawWith
C
s
"TextBox"
_DefaultSize
C
s
"24,4"
_DefaultEvent
C
s
"Change"
:Change
:


:Completion
:

(Text)s
Text
p
s

:Activate
:


:Clear
:


ReadOnly
p
b

PlaceHolder
p
s

Password
p
b

ShowClear
p
b

_new
m


Clear
m


Copy
m


_Render
m


_UpdateProperty
m

(sProp)s(vValue)v
CompleteWith
m

(CompletionList)String[];
#WebTimer
WebControl
C
_IsControl
C
b
T
_IsVirtual
C
b
T
_Properties
C
s
"*,-Class,-Width,-Height,-Visible,-Expand,-Ignore,Enabled,Delay{Range:0;86400000;10;ms}=1000"
_Group
C
s
"Special"
_DefaultEvent
C
s
"Timer"
:Timer
:


Delay
p
i

Enabled
p
b

_new
m


_BeforeRender
m


_Render
m


_AfterRender
m


Start
m


Stop
m


Restart
m


Delete
m


Refresh
m


#WebTree
WebControl
C
'This control implements a tree view of selectable text items with icons.
'
'Tree view items are indexed by a key. They display a string and an icon for each item.
'
'This control has an internal cursor used for accessing its items. Use the [./movefirst], [./movenext], [./moveto]... methods to move the
'internal cursor, and the [./item] property to get the item it points at.
_Properties
C
s
"*,Border=True,Mode{Select.*}=Single,ShowCheck,ShowHeader"
_Group
C
s
"View"
_DrawWith
C
s
"TreeView"
_DefaultSize
C
s
"24,24"
_DefaultEvent
C
s
"Click"
Count
r
i

'Returns the number of items in the view.
Mode
p
i

'Returns or sets the selection mode.
'
'See the [../select] class For a list of constants to use with this property.
Keys
r
String[]

'Return a list of all items keys
Item
r
_WebTreeItem

'Return the item pointed by the internal cursor, or [/lang/null] if the internal cursor is not available.
Current
r
_WebTreeItem

'Return the current item, i.e. the item is selected in single selection mode.
Key
p
s

'Return the key of the [../current] item.
Available
r
b

'Return if the [../item] property is valid.
Compare
p
i

Selection
r
String[]

'Return the keys of the selected items as as string array.
ShowHeader
p
b

'Return or set if the header is visible.
ShowCheck
p
b

'Return or set if selection is indicated by check boxes and radio buttons, or by highlighting the items.
'
'Check boxes are used in multiple selection mode, radio buttons in single selection mode.
Columns
r
_WebTreeColumns

'Return a virtual collection of the columns of the view.
ScrollX
p
i

'Return or set the horizontal scrolling position.
ScrollY
p
i

'Return or set the vertical scrolling position.
:Activate
:


'This event is raised when an item is double-clicked.
'
'The internal cursor is set to the clicked item.
:Select
:


'This event is raised when the selection changes.
'
'The internal cursor is set to the expanded item.
:Expand
:


'This event is raised when an item is expanded.
'
'The internal cursor is set to the expanded item.
:Collapse
:


'This event is raised when an item is collapsed.
'
'The internal cursor is set to the collapsed item.
:Compare
:

(Key)s(OtherKey)s
:Data
:

(Key)s(Column)i(Data)WebTreeData;
'This event is raised when the contents of a specific item is needed (usually to draw it).
'
'- ~Key~ is the item key.
'- ~Column~ is the item column.
'
'You must provide the item contents by setting the fields of the ~Data~ argument.
:Click
:

(Key)s(Column)i
'This event is raised when a control [embedded in a cell](../../webtreedata/control) raises its 'Click' event.
_new
m


'Create a new WebTree control.
AddColumn
m
_WebTableColumn
(Text)s[(Width)s(Alignment)i]
'Add a new column to the view.
'
'- ~Text~ is the title of the column.
'- ~Width~ is its width, or '*' if the column must expand. If the width is not specified, the column will fit its contents.
'- ~Alignment~ is the column alignment, among [Align.Left](../../align/left), [Align.Center](../../align/center),[Align.Right](../../align/right) and [Align.Normal](../../align/normal) (the default).
'
'The column object is returned.
_get
m
_WebTreeItem
(Key)s
'Return an item from its key.
Exist
m
b
(Key)s
'Return if an item exists with the ~Key~ key.
Clear
m


'Clear the view.
UnSelectAll
m


'Unselect all items in the view.
_RefreshView
m


Add
m
_WebTreeItem
(Key)s(Text)s[(Image)s(Parent)s(After)s]
'Add an item to the view.
'
'* ~Key~ is the key of the new item.
'* ~Text~ is the text of the new item.
'* ~Image~ is the relative path of the image displayed besides the item. By default, no image is displayed.
'* ~Parent~ is the key of the parent item where the item will be inserted. By default, the new item is a root item.
'* ~After~ is the key of an item that the new item will directly follows. This item and the new item must have the same parent. By default, the new item become the last child of its parent.
'
'The newly created item is returned.
_MoveItem
m
b
(hItem)_WebTreeItem;(sKey)s(bBefore)b
_GetParentItem
m
_WebTreeItem
(hItem)_WebTreeItem;
Remove
m

(Key)s
'Remove an item from the view.
'
'~Key~ is the key of the item to remove.
_SetSelected
m

(sKey)s(bSelected)b[(bNoRefresh)b]
_ReparentItem
m

(hItem)_WebTreeItem;(Parent)s
_AddCount
m

(iCount)i
_RowToItem
m
_WebTreeItem
(iRow)i
_ItemToRow
m
i
(hItem)_WebTreeItem;
_RaiseCompare
m
i
(sKey)s(sOtherKey)s
_RaiseExpand
m

(sKey)s(bExpand)b
MoveFirst
m
b

'Move the internal cursor to the first item of the view.
'
'Return [/lang/true] if the view is void.
MoveLast
m
b

'Move the internal cursor to the last item of the view.
'
'Return [/lang/true] if the view is void.
MoveBack
m
b

'When one of the other Move... methods has failed, you can use this one
'to move the internal cursor back to its position before the move.
'
'Return [/lang/true] if the internal cursor was not at a valid position.
MoveTo
m
b
(Key)s
'Move the internal cursor to a specified item.
'
'Return [/lang/true] if the item does not exist.
MoveAbove
m
b

'Move the internal cursor one visible item above.
'
'Return [/lang/true] if there is no item above.
MoveBelow
m
b

'Move the internal cursor one visible item below.
'
'Return [/lang/true] if there is no item below.
MoveChild
m
b

'Move the internal cursor to the first child item of the item currently pointed by the internal cursor.
'
'Returns [/lang/true] if there is no child item.
MoveNext
m
b

'Move the internal cursor to the next child item.
'
'Return [/lang/true] if there is no child item left.
MovePrevious
m
b

'Move the internal cursor to the previous child item.
'
'Return [/lang/true] if there is no child item left.
MoveParent
m
b

'Move the internal cursor to the parent item of the item currently pointed by the internal cursor.
'
'Return [/lang/true] if there is no parent item.
SelectAll
m


'Select all items in the view.
_IsSelected
m
b
(sKey)s
_SaveSelection
m


_RestoreSelection
m


_GetLayout
m
v

_SetLayout
m

(Value)v
_Render
m


_IsEverythingSelected
m
b

_UpdateProperty
m

(sProp)s(vValue)v
_RaiseCellEvent
m

(sCell)s(sEvent)s(aArg)Variant[];
#WebTreeData

C
'This class allows to define the contents of a WebTree cell through its [../webtree/.data] event.
Text
v
s

'Return or set the text displayed in the cell.
Html
v
s

'Return or set the HTML contents of the cell.
Background
v
i

'Return or set the background color of the cell.
Foreground
v
i

'Return or set the foreground color of the cell.
Image
v
s

'Return or set the image displayed in the cell.
Control
v
WebControl

'Setting this property will embed a duplicated version of the control into the cell.
#WebVBox
WebContainer
C
'A container that lays out its content vertically.
_Properties
C
s
"*,-Arrangement"
_DefaultArrangement
C
s
"V"
_Similar
C
s
"WebContainer"
_new
m


#_WebTableColumn

C
Text
p
s

Expand
p
b

Alignment
p
i

Wrap
p
b

Width
p
s

Hidden
p
b

Sortable
p
b

:_Fake
:


_Column
v
i

_PrintAlignment
m


#_WebTableColumns

C
Count
p
i

:_Fake
:


_Render
m


_get
m
_WebTableColumn
(Index)i
#_WebTreeColumn
_WebTableColumn
C
#_WebTreeColumns

C
Count
p
i

:_Fake
:


_Render
m


_get
m
_WebTreeColumn
(Index)i
#_WebTreeItem

C
Key
r
s

'Return the item key
ParentKey
r
s

'Return the key of the parent item, or 'NULL' if the item has no parent.
Text
p
s

'Return or set the item text.
Html
p
s

'Return or set the item HTML text.
'
'If the Html property is defined, the [Text](../text) property is ignored.
Image
p
s

'Return or set the item image.
Count
r
i

'Return the number of children items.
Children
r
i

'Return the number of children items.
Expanded
p
b

'Return of set if the item is expanded.
Editable
p
b

'Return or set if the item is editable.
'
'This property has no effect at the moment.
Selected
p
b

'Return or set if the item is selected.
Background
p
i

'Return or set the item background color.
Foreground
p
i

'Return or set the item foreground color.
Tag
p
v

'This property is intended for the programmer and is never used by the component. It can contain any [/lang/type/variant] value.
Depth
r
i

'Return the item depth inside the whole tree.
_Tree
V
WebTree

_Depth
v
i

_Rows
v
i

_Index
v
i

_GrandChildren
v
i

:_Refresh
:


_IsRoot
m
b

_ComputeDepth
m


_ComputeGrandChildren
m


_SetParent
m

(sParent)s
_new
m

(sKey)s(sParent)s
_ComputeRows
m

(iAdd)i
_AddChild
m

(sKey)s
_RemoveChild
m

(hItem)_WebTreeItem;
_GetChildren
m
String[]

Clear
m


'Remove all item children.
Delete
m


'Remove the item.
EnsureVisible
m


'Ensure that the item is visible on the screen.
MoveBefore
m

[(Key)s]
'Move the item just before another item.
'
'- ~Key~ : key of the reference item. The reference item must have the same parent as the moved item.
'
'If no reference item is specified, the item is moved so that it becomes the last child of its parent.
MoveAfter
m

[(Key)s]
'Move the item just after another item.
'
'- ~Key~ : key of the reference item. The reference item must have the same parent as the moved item.
'
'If no reference item is specified, the item is moved so that it becomes the first child of its parent.
MoveFirst
m


'Move the item so that it becomes the first child of its parent.
MoveLast
m


'Move the item so that it becomes the last child of its parent.
_compare
m
i
(hOther)_WebTreeItem;
_put
m

(Text)s(Column)i
'Set the text contents of a column for the item.
'
'- ~Column~ : the column index.
_get
m
s
(Column)i
'Return the text contents of a column for the item.
'
'- ~Column~ : the column index.
Reparent
m

(NewParent)s
'Change the parent of the item.
'
'- ~NewParent~ : key of the new parent.
