Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sReturnTypes2100%height: 30px;2ExtendssWordListBLOCK

servoy sSummary12%30%58%height: 30px;3Property SummaryEnables a component to stick to a specific side of form and/or to grow or shrink when a window is resized.The background color of the component.The type, color and style of border of the component.The dataprovider of the component.Flag that enables or disables merging of data inside components using tags (placeholders).The enable state of the component, default true.The font type of the component.The foreground color of the component.The Z index of this component.The format that should be applied when displaying data(using dataProviderID) in the label/button.A String representing a group ID for this component.The height in pixels of the component.Horizontal alignment of the text inside the component.The image Media object that should be displayed inside the component.Some components can be set to be labels of other components.The margins of the component.Options to scale the image Media object that is displayed inside the component.The keyboard shortcut that activates this component.The name of the component.The method that is executed when the component is clicked.The method that is executed when the component is double clicked.The method that is executed when the component is rendered.The method that is executed when the component is right clicked.Enables an element to resize based on its content and/or move when printing.Flag that tells if the component should be printed or not when the form is printed.The cursor that is shown as the mouse is rolled over the component.The roll over image Media object used.The rotation of the element.When set, the element will show the clicked state when selected.When set the text of an element will showfocus when selected.The name of the style class that should be applied to this component.An index that specifies the position of the component in the tab sequence.The text that is displayed inside the component.The text displayed when hovering over the component with a mouse cursor.Flag that tells if the component is transparent or not.The vertical alignment of the text inside the component.The visible property of the component, default true.The width in pixels of the component.The x coordinate of the component on the form.The y coordinate of the component on the form.

servoy sSummary12%30%58%height: 30px;3Methods SummaryGet the value of an attribute of the element.Returns the attribute names of an element.Get a design-time property of an element.Get the design-time properties of an element.Returns the name of the form.Get title label for the label.Returns the UUID of this component.Set a design-time property of an element.Remove the attribute of an element.Clear a design-time property of an element.voidSet the attribute value of an element.

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowpropertyservoy sDetail2100%height:30px2Property Detailsanchorsname

anchors

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
backgroundname

background

dessIndent
The background color of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
borderTypename

borderType

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
dataProviderIDname

dataProviderID

dessIndent
The dataprovider of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
displaysTagsname

displaysTags

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
enabledname

enabled

dessIndent
The enable state of the component, default true.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
fontTypename

fontType

dessIndent
The font type of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
foregroundname

foreground

dessIndent
The foreground color of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
formIndexname

formIndex

dessIndent
The Z index of this component. If two components overlap,
then the component with higher Z index is displayed above
the component with lower Z index.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
formatname

format

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
groupIDname

groupID

dessIndent
A String representing a group ID for this component. If several
components have the same group ID then they belong to the same
group of components. Using the group itself, all components can
be disabled/enabled or made invisible/visible.
The group id should be a javascript compatible identifier to allow access of the group in scripting.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
heightname

height

dessIndent
The height in pixels of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
horizontalAlignmentname

horizontalAlignment

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
imageMedianame

imageMedia

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
labelForname

labelFor

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
labelSizename

labelSize

dessIndentretmarginname

margin

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
mediaOptionsname

mediaOptions

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
mnemonicname

mnemonic

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
namename

name

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
onActionname

onAction

dessIndent
The method that is executed when the component is clicked.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onDoubleClickname

onDoubleClick

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onRendername

onRender

dessIndent
The method that is executed when the component is rendered.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onRightClickname

onRightClick

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
printSlidingname

printSliding

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
printablename

printable

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

By default components are printable.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
rolloverCursorname

rolloverCursor

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
rolloverImageMedianame

rolloverImageMedia

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
rotationname

rotation

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showClickname

showClick

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showFocusname

showFocus

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
styleClassname

styleClass

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
tabSeqname

tabSeq

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
textname

text

dessIndent
The text that is displayed inside the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
toolTipTextname

toolTipText

dessIndent
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>
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
transparentname

transparent

dessIndent
Flag that tells if the component is transparent or not.

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
verticalAlignmentname

verticalAlignment

dessIndent
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.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
visiblename

visible

dessIndent
The visible property of the component, default true.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
widthname

width

dessIndent
The width in pixels of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
xname

x

dessIndent
The x coordinate of the component on the form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
yname

y

dessIndent
The y coordinate of the component on the form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascriptlastDetailRowfunctionservoy sDetail2100%height:30px2Methods DetailsgetAttributename

getAttribute(name)

dessIndent
Get the value of an attribute of the element.
prs

Parameters

sIndentnamethe name of the attribute
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getAttributesname

getAttributes()

dessIndent
Returns the attribute names of an element.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDesignTimePropertyname

getDesignTimeProperty(key)

dessIndent
Get a design-time property of an element.
prs

Parameters

sIndentkeythe name of the property
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDesignTimePropertyNamesname

getDesignTimePropertyNames()

dessIndent
Get the design-time properties of an element.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormNamename

getFormName()

dessIndent
Returns the name of the form. (may be empty string as well)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getTitlename

getTitle()

dessIndent
Get title label for the label.
retgetUUIDname

getUUID()

dessIndent
Returns the UUID of this component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
putDesignTimePropertyname

putDesignTimeProperty(key, value)

dessIndent
Set a design-time property of an element.
prs

Parameters

sIndentkeythe name of the propertyvaluethe value to store
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeAttributename

removeAttribute(name)

dessIndent
Remove the attribute of an element.
prs

Parameters

sIndentnamethe name of the attribute
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeDesignTimePropertyname

removeDesignTimeProperty(key)

dessIndent
Clear a design-time property of an element.
prs

Parameters

sIndentkeythe name of the property
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setAttributename

setAttribute(name, value)

dessIndent
Set the attribute value of an element.
prs

Parameters

sIndentnamethe name of the attributevaluethe value of the attribute
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow