How to use the JSListPicker¶

NOTE: this applies to version 1.0

• Table of contents
• How to use the JSListPicker
  • Example
  • Available properties and functions
    • newColumn()
    • newSearchColumn()
    • getAllSearchColumns()
    • newFilterParam()
    • getAllFilterParams()
    • Directly accessible properties

Example¶

The minimum settings you need to use are the following:

// Get an instance of the JSListPicker
var _oLP = globals.LISTPICKER.createPicker(),
    _oCL;

// The datasource of the form and what column we need to return
_oLP.form.server = "user_data";
_oLP.form.table = "people";
_oLP.form.pickColumn = "zzid_people";

// How are we gonna return the picked value
_oLP.callback.formName = "myUniqueFormName";
_oLP.callback.dataprovider = "myFormVariable"; // can be a variable or a columnName

// What columns are we gonna show, at least 1 column is required
_oCL = _oLP.newColumn();
_oCL.dataprovider = "name_first";
_oCL.titleText = "First Name";

// On what columns are we gonna search. at least 1 column is required
_oCL = _oLP.newSearchColumn();
_oCL.dataprovider = "name_first";

// Now show the listpicker window
_oLP.show()

Available properties and functions¶

Some of the properties are required but have a default value and therefor don't need to be set when you don't want to change the default.

The following functions are available:

newColumn()¶

This adds and returns a JSLP_Column object with the following properties

newSearchColumn()¶

This adds and returns a JSLP_SearchColumn object with the following properties

getAllSearchColumns()¶

This returns an array with the available searchcolumn objects.

newFilterParam()¶

This adds and returns a JSLP_FilterParam object with the following properties

getAllFilterParams()¶

This returns an array with the available searchcolumn objects.

Directly accessible properties¶