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.



Property Summary
Number
anchors
Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.
Object
designTimeProperties
Property to get and add design-time properties for a component.
Boolean
enabled
The enable state of the component, default true.
Number
formIndex
String
location
The x and y position of the component, in pixels, separated by a comma.
String
name
The name of the component.
Boolean
printable
Flag that tells if the component should be printed or not when the form is printed.
String
size
The width and height (in pixels), separated by a comma.
Number
tabSeq
An index that specifies the position of the component in the tab sequence.
Boolean
visible
The visible property of the component, default true.



Property Details

anchors

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.

Returns

Number
 

designTimeProperties

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

Returns

Object - map of the design-time properties
 

enabled

The enable state of the component, default true.

Returns

Boolean - enabled state
 

formIndex

Returns

Number
 

location

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

Returns

String
 

name

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

Returns

String
 

printable

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

By default components are printable.

Returns

Boolean
 

size

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

Returns

String
 

tabSeq

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.

Returns

Number
 

visible

The visible property of the component, default true.

Returns

Boolean - visible property