Supported Clients
SmartClient
WebClient
NGClient

Property Summary
String
background
The background color of the component.
String
borderType
The type, color and style of border of the component.
Object
designTimeProperties
Property to get and add design-time properties for a component.
Boolean
enabled
The enable state of the component, default true.
String
foreground
The foreground color of the component.
Number
formIndex
Form index returns the z-index of the form element.
Number
lineSize
The width of the line used for drawing the rectangle.
String
name
The name of the component.
Number
printSliding
Enables an element to resize based on its content and/or move when printing.
Boolean
printable
Flag that tells if the component should be printed or not when the form is printed.
Number
roundedRadius
The rounding radius in pixels.
Number
shapeType
The type of the shape.
String
size
The width and height (in pixels), separated by a comma.
Boolean
transparent
Flag that tells if the component is transparent or not.
Boolean
visible
The visible property of the component, default true.

Property Details

background

The background color of the component.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

borderType

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

designTimeProperties

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

Returns

Object map of the design-time properties

Supported Clients

SmartClient,WebClient,NGClient

Sample

enabled

The enable state of the component, default true.

Returns

Boolean enabled state

Supported Clients

SmartClient,WebClient,NGClient

Sample

foreground

The foreground color of the component.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

formIndex

Form index returns the z-index of the form element. If two elements overlap,
then the element with higher Z index is displayed above the form element with lower Z index.
In case of form inheritance, form index is evaluated in the context (form) where property is defined.
Elements which have child form as context will always be on top of elements which have parent form.
If element is overridden in child form but form index property is still inherited its context is still parent form.

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient

Sample

lineSize

The width of the line used for drawing the rectangle.

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient

Sample

name

The name of the component. Through this name it can also accessed in methods.
Must be a valid javascript name. (no - in the name or start with number)

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

printSliding

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.

Returns

Number

Supported Clients

SmartClient,WebClient

Sample

printable

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

By default components are printable.

Returns

Boolean

Supported Clients

SmartClient,WebClient

Sample

roundedRadius

The rounding radius in pixels.

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient

Sample

shapeType

The type of the shape. The type can be BORDER_PANEL, RECTANGLE, ROUNDED_RECTANGLE or OVAL.

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient

Sample

size

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

transparent

Flag that tells if the component is transparent or not.

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

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient

Sample

visible

The visible property of the component, default true.

Returns

Boolean visible property

Supported Clients

SmartClient,WebClient,NGClient

Sample