Child pages
  • Portal

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 ClientssWordListSmartClientsWordListWebClientsWordListNGClient

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.Property to get and add design-time properties for a component.The enable state of the component, default true.Form index returns the z-index of the form element.The default sort order for the rows displayed in the portal.The additional spacing between cell rows.The x and y position of the component, in pixels, separated by a comma.When set, portal rows can have a custom layout of fields, buttons, etc.The name of the component.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 name of the relationship between the table related to the currently active form and the table you want to show data from in the portal.When set, the portal rows can be re-ordered by dragging the column headers.When set the portal rows can be resized by users.The calculation dataprovider (such as servoy_row_bgcolor) used to add background color and highlight selected or alternate portal rows.The height of each row in pixels.Scrollbar options for the vertical and horizontal scrollbars.When set, the portal displays horizontal lines between the rows.When set the portal displays vertical lines between the columns.The width and height (in pixels), separated by a comma.When set, users can sort the contents of the portal by clicking on the column headings.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.Flag that tells if the component is transparent or not.The visible property of the component, default true.

servoy sSummary12%30%58%height: 30px;3Event SummaryvoidThe method that is triggered when (non Design Mode) dragging occurs.voidThe method that is triggered when (non Design Mode) dragging end occurs.voidThe method that is triggered when (non Design Mode) dragging over a component occurs.voidThe method that is triggered when (non Design Mode) dropping occurs.voidThe method that is executed when the component is rendered.

propertyservoy sDetail2100%height:30px2Property Detailsanchorsname

anchors

dessIndentEnables 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

dessIndentThe background color of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
borderTypename

borderType

dessIndentThe type, color and style of border of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
designTimePropertiesname

designTimeProperties

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
enabledname

enabled

dessIndentThe enable state of the component, default true.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
formIndexname

formIndex

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
initialSortname

initialSort

dessIndentThe default sort order for the rows displayed in the portal.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
intercellSpacingname

intercellSpacing

dessIndentThe additional spacing between cell rows. Is composed from the horizontal spacing and the vertical spacing.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
locationname

location

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
multiLinename

multiLine

dessIndentWhen set, portal rows can have a custom layout of fields, buttons, etc. displayed for each matching row (rather than the default "grid").ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
namename

name

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
ngReadOnlyModename

ngReadOnlyMode

dessIndentret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
printSlidingname

printSliding

dessIndentEnables 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

dessIndentFlag 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 
relationNamename

relationName

dessIndentThe name of the relationship between the table related to the currently active form and the table you want to show data from in the portal.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
reorderablename

reorderable

dessIndentWhen set, the portal rows can be re-ordered by dragging the column headers.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
resizablename

resizable

dessIndentWhen set the portal rows can be resized by users.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
rowBGColorCalculationname

rowBGColorCalculation

dessIndentThe calculation dataprovider (such as servoy_row_bgcolor) used to add background color and highlight selected or alternate portal rows. NOTE: This property has been deprecated and is kept visible for legacy purposes. Use CSS Row Styling & onRender event instead.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
rowHeightname

rowHeight

dessIndentThe height of each row in pixels. If 0 or not set, the height defaults to 10.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
scrollbarsname

scrollbars

dessIndentScrollbar options for the vertical and horizontal scrollbars. Each of the vertical and horizontal scrollbars can be configured to display all the time, to display only when needed or to never display.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
showHorizontalLinesname

showHorizontalLines

dessIndentWhen set, the portal displays horizontal lines between the rows. NOTE: In a multi-line portal, a horizontal line is only displayed in the selected row; to display a horizontal line in all rows, add a line to the portal.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
showVerticalLinesname

showVerticalLines

dessIndentWhen set the portal displays vertical lines between the columns. NOTE: In a multi-line portal, a vertical line is only displayed in the selected row; to display a vertical line in all rows, add a line to the portal.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
sizename

size

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
sortablename

sortable

dessIndentWhen set, users can sort the contents of the portal by clicking on the column headings.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
styleClassname

styleClass

dessIndentThe 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
sam

Sample

sIdentjavascript
lastDetailRow 
tabSeqname

tabSeq

dessIndentAn 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 
transparentname

transparent

dessIndentFlag 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 
visiblename

visible

dessIndentThe visible property of the component, default true.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 

eventservoy sDetail2100%height:30px2Event DetailsonDragname

onDrag()

dessIndentThe method that is triggered when (non Design Mode) dragging occurs.ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow 
onDragEndname

onDragEnd()

dessIndentThe method that is triggered when (non Design Mode) dragging end occurs.
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow 
onDragOvername

onDragOver()

dessIndentThe method that is triggered when (non Design Mode) dragging over a component occurs.
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow 
onDropname

onDrop()

dessIndentThe method that is triggered when (non Design Mode) dropping occurs.
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow 
onRendername

onRender()

dessIndentThe method that is executed when the component is rendered.
ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow