Page History

Div

style	display:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Event Summary

Table Row (tr)

Table Cell (td)

Table Cell (td)
onAction The method that is executed when the component is clicked.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onDoubleClick The method that is executed when the component is double clicked.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onRender The method that is executed when the component is rendered.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onRightClick The method that is executed when the component is right clicked.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
anchors Enables a component to stick to a specific side of form and/or to grow or shrink when a window is resized.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
background The background color of the component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
borderType The type, color and style of border of the component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
dataProvider The dataprovider of the component.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
designTimeProperties Property to get and add design-time properties for a component.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
displaysTags Flag that enables or disables merging of data inside components using tags (placeholders).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
enabled The enable state of the component, default true.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
fontType The font type of the component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
foreground The foreground color of the component.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
formIndex

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
format The format that should be applied when displaying data(using dataProviderID) in the label/button.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
horizontalAlignment Horizontal alignment of the text inside the component.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
imageMedia The image Media object that should be displayed inside the component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
labelFor Some components can be set to be labels of other components.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
location The x and y position of the component, in pixels, separated by a comma.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
margin The margins of the component.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
mediaOptions Options to scale the image Media object that is displayed inside the component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
mnemonic The keyboard shortcut that activates this component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
name The name of the component.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
printSliding Enables an element to resize based on its content and/or move when printing.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
printable Flag that tells if the component should be printed or not when the form is printed.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
rolloverCursor The cursor that is shown as the mouse is rolled over the component.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
rolloverImageMedia The roll over image Media object used.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
showClick When set, the element will show the clicked state when selected.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
showFocus When set the text of an element will showfocus when selected.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
size The width and height (in pixels), separated by a comma.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
styleClass The name of the style class that should be applied to this component.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
tabSeq An index that specifies the position of the component in the tab sequence.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
text The text that is displayed inside the component.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
textRotation The rotation of the element.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
toolTipText The text displayed when hovering over the component with a mouse cursor.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
transparent Flag that tells if the component is transparent or not.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
verticalAlignment The vertical alignment of the text inside the component.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
visible The visible property of the component, default true.

HTML Table

id	event
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Event Details

Table Body (tbody)

id	onAction

Table Row (tr)

id	name

Table Cell (td)
onAction

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is clicked.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDoubleClick-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onDoubleClick

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is double clicked.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRender

Table Row (tr)

id	name

Table Cell (td)
onRender

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is rendered.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRightClick

Table Row (tr)

id	name

Table Cell (td)
onRightClick

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is right clicked.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	anchors

Table Row (tr)

id	name

Table Cell (td)
anchors

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.

If opposite anchors are activated then the component with grow or
shrink with the window. For example if Top and Bottom are activated,
then the component will grow/shrink when the window is vertically
resized. If Left and Right are activated then the component
will grow/shrink when the window is horizontally resized.

If opposite anchors are not activated, then the component will
keep a constant distance from the sides of the window which
correspond to the activated anchors.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	background

Table Row (tr)

id	name

Table Cell (td)
background

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The background color of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	borderType

Table Row (tr)

id	name

Table Cell (td)
borderType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The type, color and style of border of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	dataProvider

Table Row (tr)

id	name

Table Cell (td)
dataProvider

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The dataprovider of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	designTimeProperties

Table Row (tr)

id	name

Table Cell (td)
designTimeProperties

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Property to get and add design-time properties for a component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object - map of the design-time properties

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	displaysTags

Table Row (tr)

id	name

Table Cell (td)
displaysTags

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Flag that enables or disables merging of data inside components using tags (placeholders).
Tags (or placeholders) are words surrounded by %%on each side. There are data tags and
standard tags. Data tags consist in names of dataproviders surrounded by%%. Standard tags
are a set of predefined tags that are made available by the system.

See the "Merging data" section for more details about tags.

The default value of this flag is "false", that is merging of data is disabled by default.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	enabled

Table Row (tr)

id	name

Table Cell (td)
enabled

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The enable state of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - enabled state

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	fontType

Table Row (tr)

id	name

Table Cell (td)
fontType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The font type of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	foreground

Table Row (tr)

id	name

Table Cell (td)
foreground

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The foreground color of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	formIndex

Table Row (tr)

id	name

Table Cell (td)
formIndex

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	format

Table Row (tr)

id	name

Table Cell (td)
format

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The format that should be applied when displaying data(using dataProviderID) in the label/button.
Some examples are "#%", "dd-MM-yyyy", "MM-dd-yyyy", etc.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	horizontalAlignment

Table Row (tr)

id	name

Table Cell (td)
horizontalAlignment

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Horizontal alignment of the text inside the component. Can be one of
LEFT, CENTER or RIGHT.

Note that this property does not refer to the horizontal alignment
of the component inside the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	imageMedia

Table Row (tr)

id	name

Table Cell (td)
imageMedia

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The image Media object that should be displayed inside the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	labelFor

Table Row (tr)

id	name

Table Cell (td)
labelFor

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Some components can be set to be labels of other components. This is useful in
two situations. In table view mode it is used for constructing the header of the
table. In record view mode, by setting mnemonics on the label, keyboard shortcuts
can be used to set the focus to fields.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	location

Table Row (tr)

id	name

Table Cell (td)
location

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The x and y position of the component, in pixels, separated by a comma.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	margin

Table Row (tr)

id	name

Table Cell (td)
margin

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The margins of the component. They are specified in this order,
separated by commas: top, left, bottom, right.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mediaOptions

Table Row (tr)

id	name

Table Cell (td)
mediaOptions

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Options to scale the image Media object that is displayed inside the component.
Can be set to one or a combination of CROP, REDUCE, ENLARGE and KEEPASPECT.

REDUCE will scale down the image if the component is smaller than the image.
REDUCE combined with KEEPASPECT will reduce the image, but keep its aspect ratio.
This is useful when the component has other proportions than the image.

ENLARGE will scale up the image if the component is larger than the image.
ENLARGE combined with KEEPASPECT will scale up the image while keeping its aspect ratio.

CROP will leave the image at its original size. If the component is smaller than
the image this will result in only a part of the image showing up.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	mnemonic

Table Row (tr)

id	name

Table Cell (td)
mnemonic

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The keyboard shortcut that activates this component. A letter must be specified,
and the actual shortcut will be combination of ALT + the specified letter.

This property can be used in two ways. Normally the keyboard shortcut activates
the onClick event of the component. But if the "labelFor" property is set for the
component, then the keyboard shortcut will move the focus to the component whose
label this component is.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the component. Through this name it can also accessed in methods.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printSliding

Table Row (tr)

id	name

Table Cell (td)
printSliding

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Enables an element to resize based on its content and/or move when printing.
The component can move horizontally or vertically and can grow or shrink in
height and width, based on its content and the content of neighboring
components.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printable

Table Row (tr)

id	name

Table Cell (td)
printable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Flag that tells if the component should be printed or not when the form is printed.

By default components are printable.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	rolloverCursor

Table Row (tr)

id	name

Table Cell (td)
rolloverCursor

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The cursor that is shown as the mouse is rolled over the component.
Possible options are DEFAULT and HAND. Note that roll over cursor is not supported in Smart client for list view and tableview forms.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	rolloverImageMedia

Table Row (tr)

id	name

Table Cell (td)
rolloverImageMedia

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The roll over image Media object used. It will only work if a property image is also used.
When the mouse is moved over the component, this image Media will be displayed.
When the mouse is moved out of the component, whatever text or image was being initially
displayed will be restored. Note that roll over image is not supported in Smart client for list view and tableview forms.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showClick

Table Row (tr)

id	name

Table Cell (td)
showClick

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set, the element will show the clicked state when selected.
Applies to labels and buttons and images only.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showFocus

Table Row (tr)

id	name

Table Cell (td)
showFocus

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set the text of an element will showfocus when selected.
Applies to labels and buttons only.
The text property for the element MUST be filled in first.

NOTE: The TAB key may also be used to select the element, depending
on the operating system being used and the selected LAF.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	size

Table Row (tr)

id	name

Table Cell (td)
size

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The width and height (in pixels), separated by a comma.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleClass

Table Row (tr)

id	name

Table Cell (td)
styleClass

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the style class that should be applied to this component.

When defining style classes for specific component types, their names
must be prefixed according to the type of the component. For example
in order to define a class names 'fancy' for fields, in the style
definition the class must be named 'field.fancy'. If it would be
intended for labels, then it would be named 'label.fancy'. When specifying
the class name for a component, the prefix is dropped however. Thus the
field or the label will have its styleClass property set to 'fancy' only.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	tabSeq

Table Row (tr)

id	name

Table Cell (td)
tabSeq

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

An index that specifies the position of the component in the tab sequence. The components
are put into the tab sequence in increasing order of this property. A value of 0 means
to use the default mechanism of building the tab sequence (based on their location on the form).
A value of -2 means to remove the component from the tab sequence.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	text

Table Row (tr)

id	name

Table Cell (td)
text

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The text that is displayed inside the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	textRotation

Table Row (tr)

id	name

Table Cell (td)
textRotation

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The rotation of the element. You can choose 0, 90, 180, or 270 and the label is rotated accordingly.
This property also applies to buttons and images.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	toolTipText

Table Row (tr)

id	name

Table Cell (td)
toolTipText

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The text displayed when hovering over the component with a mouse cursor.

NOTE:
HTML should be used for multi-line tooltips; you can also use any
valid HTML tags to format tooltip text. For example:
<html>This includes<b>bolded text</b> and
<font color='blue'>BLUE</font> text as well.</html>

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	transparent

Table Row (tr)

id	name

Table Cell (td)
transparent

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Flag that tells if the component is transparent or not.

The default value is "false", that is the components
are not transparent.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	verticalAlignment

Table Row (tr)

id	name

Table Cell (td)
verticalAlignment

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The vertical alignment of the text inside the component. Can be one of
TOP, CENTER or BOTTOM.

Note that this property does not refer to the vertical alignment of the
component inside the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	visible

Table Row (tr)

id	name

Table Cell (td)
visible

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The visible property of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - visible property

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Page History

Versions Compared

Old Version 11

New Version Current

Key

onAction

onDoubleClick

onRender

onRightClick

anchors

background

borderType

dataProvider

designTimeProperties

displaysTags

enabled

fontType

foreground

formIndex

format

horizontalAlignment

imageMedia

labelFor

location

margin

mediaOptions

mnemonic

name

printSliding

printable

rolloverCursor

rolloverImageMedia

showClick

showFocus

size

styleClass

tabSeq

text

textRotation

toolTipText

transparent

verticalAlignment

visible