Skip to content

SelectedColumnValues - cCJGridPromptList

Returns an array of columns values for the selected rows from the last successful use of the prompt object

Type: Function
Return Data Type: String[]

Parameters

Parameter Type Description
iCol Integer Represents the original column number (piColumnId)

Syntax

Function SelectedColumnValues Integer iCol Returns String[]

Call Example

Get SelectedColumnValues iCol to String[]Variable

Description

After you have made your prompt selection, you can call SelectedColumnValues to return an array of column values for the rows that were selected. The passed iColumn index represents the original column number (piColumnId). If the prompt list, is single-select (pbMultipleSelection is False), the array should contain one value, the selected RowId. If the list is multi-select, the array will contain all selected RowIds. Multi-select can only be used with static prompt lists (i.e., all data must be loaded at one time).

This can be used with custom and non-invoking prompt lists (peUpdateMode is umPromptCustom or umPrompnonInvoking). If pbCanceled is False, you can use this to determine what rows were selected.

Alternately, you can SelectedRowIds to return the selected RowId values.

The function uses pSelectedRows to determine which rows were selected.

Return Value

Array of column values representing the rows that were selected.