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 sSummary12%30%58%height: 30px;3Property SummaryGets or sets the enabled state of a form; also known as "grayed-out".Gets or sets the read-only state of a form; also known as "editable" Note: The field(s) in a form set as read-only can be selected and the field data can be copied to clipboard.Get/Set the current type of view of this form.

servoy sSummary12%30%58%height: 30px;3Methods SummaryDeletes all records in foundset, resulting in empty foundset.Delete current selected record, deletes mulitple selected records incase the foundset is using multiselect.Duplicate current record or record at index in the form foundset.Duplicate current record or record at index in the form foundset.Duplicate current record or record at index in the form foundset.Set the foundset in find mode.voidSets focus to a field specified by its name.voidSets focus to the first field of the form; based on tab order sequence.Returns the maximum length allowed in the specified dataprovider.Gets a value based on the specified dataprovider name.Get the used datasource.Returns the state of this form designmode.Get a design-time property of a form.Gets the forms context where it resides, returns a dataset of its structure to the main controller.Gets the form width in pixels.Returns the current cached record count of the current foundset.Get the name of this form.Gets the part height in pixels.Returns the Y offset of a given part of the form.Gets the current record index of the current foundset.Get an array with the names of the components that are part of the tab sequence.Returns the JSWindow that the form is shown in, or null if the form is not currently showing in a window.Inverts the current foundset against all rows of the current table; all records that are not in the foundset will become the current foundset.Loads all accessible records from the datasource into the form foundset.Loads the records that are currently omitted in the form foundset.Loads all accessible records from the datasource into the form foundset.Loads a (related) foundset into the form.Loads a primary key dataset, will remove related sort.Loads a (related) foundset into the form.Loads a single record by primary key, will remove related sort.Loads a single record by primary key, will remove related sort.Loads records into form foundset based on a query (also known as 'Form by query').Loads records into form foundset based on a query (also known as 'Form by query').Create a new record in the form foundset.Create a new record in the form foundset.Create a new record in the form foundset.Omit selected record(s) (add it to omit records list) in form foundset, to be shown with loadOmittedRecords.voidPrint this form with current foundset, without preview.voidPrint this form with current foundset, without preview.voidPrint this form with current foundset, without preview.voidPrint this form with current foundset, without preview.Print this form with current foundset records to xml format.Print this form with current foundset records to xml format.Recreates the forms UI components, to reflect the latest solution model.voidPerforms a relookup for the current foundset record dataproviders.Start the database search and use the results, returns the number of records, make sure you did "find" function first.Start the database search and use the results, returns the number of records, make sure you did "find" function first.Start the database search and use the results, returns the number of records, make sure you did "find" function first.voidSets the value based on a specified dataprovider name.voidSets this form in designmode with param true, false will return to normal browse/edit mode.voidSets this form in designmode with one or more callback methods.voidSets this form in designmode with one or more callback methods.voidSets this form in designmode with one or more callback methods.voidSets this form in designmode with one or more callback methods.voidSets this form in designmode with one or more callback methods.voidSets this form in designmode with one or more callback methods.voidSet the page format to use when printing.voidSet the page format to use when printing.voidSet the page format to use when printing.voidSet the preferred printer name to use when printing.voidSets the current record index of the current foundset.voidSet the tab order sequence programatically, by passing the elements references in a javascript array.voidShows the form (makes the form visible) This function does not affect the form foundset in any way.voidShows the form (makes the form visible) This function does not affect the form foundset in any way.voidShows the form (makes the form visible) This function does not affect the form foundset in any way.voidShow this form in print preview.voidShow this form in print preview.voidShow this form in print preview.voidShow this form in print preview.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidLoad data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.voidSorts the form foundset based on the given sort string.voidSorts the form foundset based on the given sort string.voidShow the sort dialog to the user a preselection sortString can be passed, to sort the form foundset.void

propertyservoy sDetail2100%height:30px2Property Detailsenabledname

enabled

dessIndent
Gets or sets the enabled state of a form; also known as "grayed-out".

Notes:
-A disabled element(s) cannot be selected by clicking the form.
-The disabled "grayed" color is dependent on the LAF set in the Servoy Smart Client Application Preferences.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowreadOnlyname

readOnly

dessIndent
Gets or sets the read-only state of a form; also known as "editable"

Note: The field(s) in a form set as read-only can be selected and the field data can be copied to clipboard.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
viewname

view

dessIndent
Get/Set the current type of view of this form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsdeleteAllRecordsname

deleteAllRecords()

dessIndent
Deletes all records in foundset, resulting in empty foundset.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowdeleteRecordname

deleteRecord()

dessIndent
Delete current selected record, deletes mulitple selected records incase the foundset is using multiselect.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
duplicateRecordname

duplicateRecord()

dessIndent
Duplicate current record or record at index in the form foundset.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
duplicateRecordname

duplicateRecord(location)

dessIndent
Duplicate current record or record at index in the form foundset.
prs

Parameters

sIndentlocationtrue adds the new record as the topmost record
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
duplicateRecordname

duplicateRecord(location)

dessIndent
Duplicate current record or record at index in the form foundset.
prs

Parameters

sIndentlocationadds at specified index
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
findname

find()

dessIndent
Set the foundset in find mode. (Start a find request), use the "search" function to perform/exit the find.

Before going into find mode, all unsaved records will be saved in the database.
If this fails (due to validation failures or sql errors) or is not allowed (autosave off), the foundset will not go into find mode.
Make sure the operator and the data (value) are part of the string passed to dataprovider (included inside a pair of quotation marks).
Note: always make sure to check the result of the find() method.

When in find mode, columns can be assigned string expressions (including operators) that are evaluated as:
General:
      c1||c2    (condition1 or condition2)
      c|format  (apply format on condition like 'x|dd-MM-yyyy')
      !c        (not condition)
      #c        (modify condition, depends on column type)
      ^         (is null)
      ^=        (is null or empty)
      <x     (less than value x)
      >x     (greater than value x)
      <=x    (less than or equals value x)
      >=x    (greater than or equals value x)
      x...y     (between values x and y, including values)
      x         (equals value x)

 Number fields:
      =x       (equals value x)
      ^=       (is null or zero)

 Date fields:
      #c       (equals value x, entire day)
      now      (equals now, date and or time)
      //       (equals today)
      today    (equals today)

 Text fields:
      #c	        (case insensitive condition)
      = x      (equals a space and 'x')
      ^=       (is null or empty)
      %x%      (contains 'x')
      %x_y%    (contains 'x' followed by any char and 'y')
      \%      (contains char '%')
      \_      (contains char '_')

Related columns can be assigned, they will result in related searches.
For example, "employees_to_department.location_id = headoffice" finds all employees in the specified location).

Searching on related aggregates is supported.
For example, "orders_to_details.total_amount = '>1000'" finds all orders with total order details amount more than 1000.

Arrays can be used for searching a number of values, this will result in an 'IN' condition that will be used in the search.
The values are not restricted to strings but can be any type that matches the column type.
For example, "record.department_id = [1, 33, 99]"
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
focusFieldname

focusField(fieldName, skipReadonly)

dessIndent
Sets focus to a field specified by its name.
If the second parameter is set to true, then readonly fields will be skipped
(the focus will be set to the first non-readonly field located after the field with the specified name; the tab sequence is respected when searching for the non-readonly field).
prs

Parameters

sIndentfieldNamethe name of the field to be focussedskipReadonlyindication to skip read only fields, if the named field happens to be read only
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
focusFirstFieldname

focusFirstField()

dessIndent
Sets focus to the first field of the form; based on tab order sequence.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDataProviderMaxLengthname

getDataProviderMaxLength(name)

dessIndent
Returns the maximum length allowed in the specified dataprovider.
prs

Parameters

sIndentnamethe dataprovider name
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDataProviderValuename

getDataProviderValue(dataProvider)

dessIndent
Gets a value based on the specified dataprovider name.
prs

Parameters

sIndentdataProviderthe dataprovider name to retieve the value for
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDataSourcename

getDataSource()

dessIndent
Get the used datasource.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getDesignModename

getDesignMode()

dessIndent
Returns the state of this form designmode.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
getDesignTimePropertyname

getDesignTimeProperty(key)

dessIndent
Get a design-time property of a form.
prs

Parameters

sIndentkeythe property name
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormContextname

getFormContext()

dessIndent
Gets the forms context where it resides, returns a dataset of its structure to the main controller.
Note1: can't be called in onload, because no context is yet available at this time.
Note2: tabindex is 1 (left) or 2 (right) for a SplitPane and 0 based for the other tabpanels; tabindex1based is the same as tabindex but is 1 based.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormWidthname

getFormWidth()

dessIndent
Gets the form width in pixels.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getMaxRecordIndexname

getMaxRecordIndex()

dessIndent
Returns the current cached record count of the current foundset.
To return the full foundset count, use: databaseManager.getFoundSetCount(...)
Tip: get the the table count of all rows in a table, use: databaseManager.getTableCount(...)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getNamename

getName()

dessIndent
Get the name of this form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getPartHeightname

getPartHeight(partType)

dessIndent
Gets the part height in pixels.
prs

Parameters

sIndentpartTypeThe type of the part whose height will be returned.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getPartYOffsetname

getPartYOffset(partType)

dessIndent
Returns the Y offset of a given part of the form.
prs

Parameters

sIndentpartTypeThe type of the part whose Y offset will be returned.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getSelectedIndexname

getSelectedIndex()

dessIndent
Gets the current record index of the current foundset.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
getTabSequencename

getTabSequence()

dessIndent
Get an array with the names of the components that are part of the tab sequence.
The order of the names respects the order of the tab sequence.
Components that are not named will not appear in the returned array, although they may be in the tab sequence.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getWindowname

getWindow()

dessIndent
Returns the JSWindow that the form is shown in, or null if the form is not currently showing in a window.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
invertRecordsname

invertRecords()

dessIndent
Inverts the current foundset against all rows of the current table; all records that are not in the foundset will become the current foundset.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loadAllRecordsname

loadAllRecords()

dessIndent
Loads all accessible records from the datasource into the form foundset.
When the form contains a related foundset it will be replaced by a default foundset on same datasource.

Notes:
-the default foundset is always limited by filters, if databaseManager.addFoundSetFilterParam function is used.
-typical use is loading the normal foundset again after form usage in a related tabpanel
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loadOmittedRecordsname

loadOmittedRecords()

dessIndent
Loads the records that are currently omitted in the form foundset.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loadRecordsname

loadRecords()

dessIndent
Loads all accessible records from the datasource into the form foundset. Typical usage is loading records after search in related tabpanel.
The difference to loadAllRecords() is that related foundset will load related records.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loadRecordsname

loadRecords(foundset)

dessIndent
Loads a (related) foundset into the form.
The form will no longer share the default foundset with forms of the same datasource, use loadAllRecords to restore the default foundset.

This will really update the foundset instance itself of the form, so now existing foundset is altered just the new foundset is shown.
This is different then doing foundset.loadRecords(foundset) because that just alters the current foundset and doesn't do anything with the foundset
that is given.

When the form uses a seperate foundset, foundset filter params are copied over from the source foundset and are merged with the existing filters.
prs

Parameters

sIndentfoundsetto load
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loadRecordsname

loadRecords(pkdataset)

dessIndent
Loads a primary key dataset, will remove related sort. Tries to preserve selection based on primary key, otherwise first record is selected.
prs

Parameters

sIndentpkdatasetto load
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loadRecordsname

loadRecords(foundset)

dessIndent
Loads a (related) foundset into the form.
The form will no longer share the default foundset with forms of the same datasource, use loadAllRecords to restore the default foundset.

This will really update the foundset instance itself of the form, so now existing foundset is altered just the new foundset is shown.
This is different then doing foundset.loadRecords(foundset) because that just alters the current foundset and doesn't do anything with the foundset
that is given.

When the form uses a seperate foundset, foundset filter params are copied over from the source foundset and are merged with the existing filters.
prs

Parameters

sIndentfoundsetto load
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loadRecordsname

loadRecords(UUIDpk)

dessIndent
Loads a single record by primary key, will remove related sort.

NOTE: This function will return true if the foundset was altered/changed. It is up to the developer to check for the presence of actual data using getSize().
prs

Parameters

sIndentUUIDpkto load
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loadRecordsname

loadRecords(singlenNmber_pk)

dessIndent
Loads a single record by primary key, will remove related sort.

NOTE: This function will return true if the foundset was altered/changed. It is up to the developer to check for the presence of actual data using getSize().
prs

Parameters

sIndentsinglenNmber_pkto load
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loadRecordsname

loadRecords(queryString)

dessIndent
Loads records into form foundset based on a query (also known as 'Form by query'). The query must be a valid sql select.
If the foundset is related this function is not allowed.
Tries to preserve selection based on primary key, otherwise first record is selected.

see foundset.loadRecords(QBSelect).

When possible, the foundset will be loaded with the given query.
This is not always possible because the foundset needs to manipulate the query when adding conditions and joins.
In that case the query will be wrapped: select pk from tab where pk = (queryString)
The result is the same, except for the ordering in the queryString which will be ignored.

The query will be wrapped when one of the following is true:
<ul>
<li>you have no order-by clause</li>
<li>you have no from keyword</li>
<li>your query is not fully qualified on the main table</li>
<li>you have a group-by, having, join or union keyword</li>
</ul>
prs

Parameters

sIndentqueryStringto load
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
loadRecordsname

loadRecords(queryString, queryArgumentsArray)

dessIndent
Loads records into form foundset based on a query (also known as 'Form by query'). The query must be a valid sql select.
If the foundset is related this function is not allowed.
Tries to preserve selection based on primary key, otherwise first record is selected.

see foundset.loadRecords(QBSelect).

When possible, the foundset will be loaded with the given query.
This is not always possible because the foundset needs to manipulate the query when adding conditions and joins.
In that case the query will be wrapped: select pk from tab where pk = (queryString)
The result is the same, except for the ordering in the queryString which will be ignored.

The query will be wrapped when one of the following is true:
<ul>
<li>you have no order-by clause</li>
<li>you have no from keyword</li>
<li>your query is not fully qualified on the main table</li>
<li>you have a group-by, having, join or union keyword</li>
</ul>
prs

Parameters

sIndentqueryStringto loadqueryArgumentsArraythe arguments to replace the questions marks in the queryString
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newRecordname

newRecord()

dessIndent
Create a new record in the form foundset.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newRecordname

newRecord(insertOnTop)

dessIndent
Create a new record in the form foundset.
prs

Parameters

sIndentinsertOnToptrue adds the new record as the topmost record
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
newRecordname

newRecord(location)

dessIndent
Create a new record in the form foundset.
prs

Parameters

sIndentlocationadds at specified index
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
omitRecordname

omitRecord()

dessIndent
Omit selected record(s) (add it to omit records list) in form foundset, to be shown with loadOmittedRecords.
This operation returns false only when form foundset is in bad state (table not accessible or not having a valid selected record)
or the record is in an edit state and can't be saved (autosave is false).

Note: The omitted records are discarded when these functions are executed: loadAllRecords, loadRecords(dataset), loadRecords(sqlstring), invert
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
printname

print()

dessIndent
Print this form with current foundset, without preview.
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
printname

print(printCurrentRecordOnly)

dessIndent
Print this form with current foundset, without preview.
prs

Parameters

sIndentprintCurrentRecordOnlyto print the current record only
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
printname

print(printCurrentRecordOnly, showPrinterSelectDialog)

dessIndent
Print this form with current foundset, without preview.
prs

Parameters

sIndentprintCurrentRecordOnlyto print the current record onlyshowPrinterSelectDialogto show the printer select dialog (default printer is normally used)
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
printname

print(printCurrentRecordOnly, showPrinterSelectDialog, printerJob)

dessIndent
Print this form with current foundset, without preview.
prs

Parameters

sIndentprintCurrentRecordOnlyto print the current record onlyshowPrinterSelectDialogto show the printer select dialog (default printer is normally used)printerJobprint to plugin printer job, see pdf printer plugin for example
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
printXMLname

printXML()

dessIndent
Print this form with current foundset records to xml format.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
printXMLname

printXML(printCurrentRecordOnly)

dessIndent
Print this form with current foundset records to xml format.
prs

Parameters

sIndentprintCurrentRecordOnlyto print the current record only
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
recreateUIname

recreateUI()

dessIndent
Recreates the forms UI components, to reflect the latest solution model.
Use this after altering the elements via solutionModel at the JSForm of this form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
relookupname

relookup()

dessIndent
Performs a relookup for the current foundset record dataproviders.
Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
searchname

search()

dessIndent
Start the database search and use the results, returns the number of records, make sure you did "find" function first.
Clear results from previous searches.

Note: Omitted records are automatically excluded when performing a search - meaning that the foundset result by default will not include omitted records.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
searchname

search(clearLastResults)

dessIndent
Start the database search and use the results, returns the number of records, make sure you did "find" function first.
Reduce results from previous searches.

Note: Omitted records are automatically excluded when performing a search - meaning that the foundset result by default will not include omitted records.
prs

Parameters

sIndentclearLastResultsboolean, clear previous search, default true
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
searchname

search(clearLastResults, reduceSearch)

dessIndent
Start the database search and use the results, returns the number of records, make sure you did "find" function first.

Note: Omitted records are automatically excluded when performing a search - meaning that the foundset result by default will not include omitted records.
prs

Parameters

sIndentclearLastResultsboolean, clear previous search, default truereduceSearchboolean, reduce (true) or extend (false) previous search results, default true
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDataProviderValuename

setDataProviderValue(dataprovider, value)

dessIndent
Sets the value based on a specified dataprovider name.
prs

Parameters

sIndentdataproviderthe dataprovider name to set the value forvaluethe value to set in the dataprovider
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDesignModename

setDesignMode(designMode)

dessIndent
Sets this form in designmode with param true, false will return to normal browse/edit mode.
prs

Parameters

sIndentdesignModesets form in design mode if true, false ends design mode.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDesignModename

setDesignMode(ondrag)

dessIndent
Sets this form in designmode with one or more callback methods.
prs

Parameters

sIndentondragonDrag method reference
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDesignModename

setDesignMode(ondrag, ondrop)

dessIndent
Sets this form in designmode with one or more callback methods.
prs

Parameters

sIndentondragonDrag method referenceondroponDrop method reference
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDesignModename

setDesignMode(ondrag, ondrop, onselect)

dessIndent
Sets this form in designmode with one or more callback methods.
prs

Parameters

sIndentondragonDrag method referenceondroponDrop method referenceonselectonSelect method reference
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDesignModename

setDesignMode(ondrag, ondrop, onselect, onresize)

dessIndent
Sets this form in designmode with one or more callback methods.
prs

Parameters

sIndentondragonDrag method referenceondroponDrop method referenceonselectonSelect method referenceonresizeonResize method reference
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDesignModename

setDesignMode(ondrag, ondrop, onselect, onresize, ondblclick)

dessIndent
Sets this form in designmode with one or more callback methods.
prs

Parameters

sIndentondragonDrag method referenceondroponDrop method referenceonselectonSelect method referenceonresizeonResize method referenceondblclickonDblClick method reference
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDesignModename

setDesignMode(ondrag, ondrop, onselect, onresize, ondblclick, onrightclick)

dessIndent
Sets this form in designmode with one or more callback methods.
prs

Parameters

sIndentondragonDrag method referenceondroponDrop method referenceonselectonSelect method referenceonresizeonResize method referenceondblclickonDblClick method referenceonrightclickonRightClick method reference
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setPageFormatname

setPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin)

dessIndent
Set the page format to use when printing.

Orientation values:
0 - Landscape mode
1 - Portrait mode

Units values:
0 - millimeters
1 - inches
2 - pixels

Note: The unit specified for width, height and all margins MUST be the same.
prs

Parameters

sIndentwidththe specified width of the page to be printed.heightthe specified height of the page to be printed.leftmarginthe specified left margin of the page to be printed.rightmarginthe specified right margin of the page to be printed.topmarginthe specified top margin of the page to be printed.bottommarginthe specified bottom margin of the page to be printed.
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
setPageFormatname

setPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation)

dessIndent
Set the page format to use when printing.

Orientation values:
0 - Landscape mode
1 - Portrait mode

Units values:
0 - millimeters
1 - inches
2 - pixels

Note: The unit specified for width, height and all margins MUST be the same.
prs

Parameters

sIndentwidththe specified width of the page to be printed.heightthe specified height of the page to be printed.leftmarginthe specified left margin of the page to be printed.rightmarginthe specified right margin of the page to be printed.topmarginthe specified top margin of the page to be printed.bottommarginthe specified bottom margin of the page to be printed.orientationthe specified orientation of the page to be printed; the default is Portrait mode
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
setPageFormatname

setPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation, units)

dessIndent
Set the page format to use when printing.

Orientation values:
0 - Landscape mode
1 - Portrait mode

Units values:
0 - millimeters
1 - inches
2 - pixels

Note: The unit specified for width, height and all margins MUST be the same.
prs

Parameters

sIndentwidththe specified width of the page to be printed.heightthe specified height of the page to be printed.leftmarginthe specified left margin of the page to be printed.rightmarginthe specified right margin of the page to be printed.topmarginthe specified top margin of the page to be printed.bottommarginthe specified bottom margin of the page to be printed.orientationthe specified orientation of the page to be printed; the default is Portrait modeunitsthe specified units for the width and height of the page to be printed; the default is pixels
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
setPreferredPrintername

setPreferredPrinter(printerName)

dessIndent
Set the preferred printer name to use when printing.
prs

Parameters

sIndentprinterNameThe name of the printer to be used when printing.
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
setSelectedIndexname

setSelectedIndex(index)

dessIndent
Sets the current record index of the current foundset.
prs

Parameters

sIndentindexthe index to select
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
setTabSequencename

setTabSequence(arrayOfElements)

dessIndent
Set the tab order sequence programatically, by passing the elements references in a javascript array.
prs

Parameters

sIndentarrayOfElementsarray containing the element references
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showname

show()

dessIndent
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
showname

show(window)

dessIndent
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.
prs

Parameters

sIndentwindowthe window in which this form should be shown, given as a window object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showname

show(window)

dessIndent
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.
prs

Parameters

sIndentwindowthe window in which this form should be shown, specified by the name of an existing window
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showPrintPreviewname

showPrintPreview()

dessIndent
Show this form in print preview.
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
showPrintPreviewname

showPrintPreview(printCurrentRecordOnly)

dessIndent
Show this form in print preview.
prs

Parameters

sIndentprintCurrentRecordOnlyto print the current record only
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
showPrintPreviewname

showPrintPreview(printCurrentRecordOnly, printerJob)

dessIndent
Show this form in print preview.
prs

Parameters

sIndentprintCurrentRecordOnlyto print the current record onlyprinterJobprint to plugin printer job, see pdf printer plugin for example (incase print is used from printpreview)
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
showPrintPreviewname

showPrintPreview(printCurrentRecordOnly, printerJob, zoomFactor)

dessIndent
Show this form in print preview.
prs

Parameters

sIndentprintCurrentRecordOnlyto print the current record onlyprinterJobprint to plugin printer job, see pdf printer plugin for example (incase print is used from printpreview)zoomFactora specified number value from 10-400
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(foundset)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentfoundsetthe foundset to load before showing the form.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(foundset, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentfoundsetthe foundset to load before showing the form.windowthe window in which this form should be shown, given as a window object.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(foundset, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentfoundsetthe foundset to load before showing the form.windowthe window in which this form should be shown, specified by the name of an existing window.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(pkdataset)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentpkdatasetthe pkdataset to load before showing the form.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(pkdataset, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentpkdatasetthe pkdataset to load before showing the form.windowthe window in which this form should be shown, given as a window object.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(pkdataset, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentpkdatasetthe pkdataset to load before showing the form.windowthe window in which this form should be shown, specified by the name of an existing window.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(query)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentquerythe query to load before showing the form.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(query, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentquerythe query to load before showing the form.windowthe window in which this form should be shown, given as a window object.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(query, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentquerythe query to load before showing the form.windowthe window in which this form should be shown, specified by the name of an existing window.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(UUIDpk)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentUUIDpkthe UUIDpk to load before showing the form.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(UUIDpk, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentUUIDpkthe UUIDpk to load before showing the form.windowthe window in which this form should be shown, given as a window object.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(UUIDpk, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentUUIDpkthe UUIDpk to load before showing the form.windowthe window in which this form should be shown, specified by the name of an existing window.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(singleNumber_pk)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentsingleNumber_pkthe singleNumber_pk to load before showing the form.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(singleNumber_pk, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentsingleNumber_pkthe singleNumber_pk to load before showing the form.windowthe window in which this form should be shown, given as a window object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(singleNumber_pk, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentsingleNumber_pkthe singleNumber_pk to load before showing the form.windowthe window in which this form should be shown, specified by the name of an existing window.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(query)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentquerythe query to load before showing the form.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(query, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentquerythe query to load before showing the form.windowthe window in which this form should be shown, given as a window object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(query, argumentsArray)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentquerythe query to load before showing the form.argumentsArraythe array of arguments for the query
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(query, argumentsArray, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentquerythe query to load before showing the form.argumentsArraythe array of arguments for the querywindowthe window in which this form should be shown, given as a window object
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(query, argumentsArray, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentquerythe query to load before showing the form.argumentsArraythe array of arguments for the querywindowthe window in which this form should be shown, specified by the name of an existing window.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showRecordsname

showRecords(query, window)

dessIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
prs

Parameters

sIndentquerythe query to load before showing the form.windowthe window in which this form should be shown, specified by the name of an existing window.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sortname

sort(sortString)

dessIndent
Sorts the form foundset based on the given sort string.
Tries to preserve selection based on primary key. If first record is selected or cannot select old record it will select first record after sort.
TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order.
prs

Parameters

sIndentsortStringthe specified columns (and sort order)
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sortname

sort(sortString, defer)

dessIndent
Sorts the form foundset based on the given sort string.
Tries to preserve selection based on primary key. If first record is selected or cannot select old record it will select first record after sort.
TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order.
prs

Parameters

sIndentsortStringthe specified columns (and sort order)deferthe "sortString" will be just stored, without performing a query on the database (the actual sorting will be deferred until the next data loading action).
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sortDialogname

sortDialog()

dessIndent
Show the sort dialog to the user a preselection sortString can be passed, to sort the form foundset.
TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sortDialogname

sortDialog(sortString)

dessIndentprs

Parameters

sIndentsortStringthe specified columns (and sort order)
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow