c_picklist


Ancestor userobject

Hierarchy
c_picklist
userobject

Author none

Library ddselector.pbl - Custom Control DD Selector, selects multi and single rows v1.0

Description A custom control that shows a list of items for selection. Single or Multiple Selection is supported.

Usage Place on your window and call the relevant methods.

Model
c_picklist
public:
constant integer ci_SINGLESELECTION = 1
constant integer ci_MULTISELECTION = 2

protected:
integer ii_LastRow = 0 // last row highlighted
integer ii_Selected = 0 // last row clicked
integer ii_SelectionMode = 0 // selection mode (see constants)
GetLastSelected () returns integer
GetLastValue () returns string
GetSelectedValues () returns string
PopulateList (as_names[], as_values[]) returns integer
SelectByRow (ai_rows[]) returns integer
SelectByRow (as_rowlist) returns integer
SelectByValues (as_valuelist) returns integer
SelectionMode (ai_selectionmode) returns (none)
SelectRow (ai_row) returns integer
Resize (none) returns (none)

Functions

GetLastSelected

Description Returns the last selected row number
Return integer
Return the row numnber the user last selected.
Access public
Arguments none
Usage ll_Row = c_mylist.GetLastSelected()

GetLastValue

Description Get the text value of the row the user last selected.
Return string
Return the item the user last selected
Access public
Arguments none
Usage ls_Item = c_mylist.GetLastValue()

GetSelectedValues

Description Return a comma seperated list of the users selected values. Mostly uised when multi selection is switched on.
Return string
Comma seperated list of selected values
Access public
Arguments none
Usage ls_Vales = c_mylist.GetSelectedValues()

PopulateList

Description Populates the list selection.
Return integer
-1, population fialed 0, no rows populated >1, number of rows populated
Access public
Arguments
Argument DataType Description
as_Names[] string List of Names for the list
as_Values[] string List of internal values for the list

Usage ll_rc = c_mylist.PopulateList( ls_names, ls_values )

SelectByRow

Description Select any rows in the array.
Return integer
  • ok - Number of rows selected
  • fail - NEgtive representing the position in array of bad value
  • Access public
    Arguments
    Argument DataType Description
    ai_rows[] integer Rows to be set as selected

    Usage c_listpicker.SelectByRow( li_Rows )

    SelectByRow

    Description Select any rows in the lisy.
    Return integer
  • ok - Number of rows selected
  • fail - Negtive representing the position in array of bad value
  • Access public
    Arguments
    Argument DataType Description
    as_RowList string Comma seperated list of rows

    Usage c_listpicker.SelectByRow( ls_Rows )

    SelectByValues

    Description Select the rows by the internal value of each row.
    Return integer
    number of rows selected
    Access public
    Arguments
    Argument DataType Description
    as_ValueList string Comma seperated list of Values to select

    Usage ll_rc = c_mylist.SelectByValues( ls_ValList )

    SelectionMode

    Description Set the selection mode for the control (multi row or single row). See the public constants for values.
    Return (none)
    Access public
    Arguments
    Argument DataType Description
    ai_selectionmode integer Mode of selection to be used.

    Usage c_picklist.SelectionMode c_picklist.ci_MULTISELECTION )

    SelectRow

    Description Select the row passed as an argument.
    Return integer
  • 1 - Number of rows selected
  • -1 - Error selecting row
  • Access public
    Arguments
    Argument DataType Description
    ai_row integer Row to be set as selected

    Usage c_listpicker.SelectRow( li_Row )
    Events

    Resize

    Description Custom Resize event resizes the inner datawindow control.
    Return (none)
    long: Always returns 0
    Arguments none

    References
    UsesUsed By
    d_picklist
    c_picklist
    c_picklist


    Document Generated: 03/09/2005 11:11:42

    Generated by PBDoc ( Unregistered Version ) DOWNLOAD PBDOC from www.pbdr.com