PopupItemPicker(Object,Object,Object,ArrayList,String,String,String,String,String,String,Boolean) Method
- Last UpdatedNov 06, 2025
- 2 minute read
The PopupItemPicker() method opens the Item Picker dialog to allow a user to pick an item from an item tree.
All overloads of this method can filter which items are included in the item tree by the item Produced and Consumed flags.
Also, all overloads of this method return the following parameters for the selected item:
- Item ID
- Item Description
- Item Display
- Item Class ID
- Item Class Description
- Item Class Display
This overload of the method:
- Includes the item Obsolete flag as an item filter
- Allows a list of items to be excluded from being selected
- Allows an empty node to be included in the item tree, to allow the user to select 'No Item'
'Declaration
Public Overloads Shared Function PopupItemPicker( _
ByVal produced As Object, _
ByVal consumed As Object, _
ByVal obsolete As Object, _
ByVal excludedItems As ArrayList, _
ByRef itemID As String, _
ByRef itemDesc As String, _
ByRef itemDisplay As String, _
ByRef itemClassID As String, _
ByRef itemClassDesc As String, _
ByRef itemClassDisplay As String, _
ByVal includeEmptyNode As Boolean _
) As Boolean
public static bool PopupItemPicker(
object produced,
object consumed,
object obsolete,
ArrayList excludedItems,
out string itemID,
out string itemDesc,
out string itemDisplay,
out string itemClassID,
out string itemClassDesc,
out string itemClassDisplay,
bool includeEmptyNode
)
Parameters
- produced
Optional. Set to true or false to filter the items included in the item tree according to the state of the item's item class Produced flag. Pass a null to not apply this filter option.
- consumed
Optional. Set to true or false to filter the items included in the item tree according to the state of the item's item class Consumed flag. Pass a null to not apply this filter option.
- obsolete
Optional. Set to true or false to filter the items included in the item tree according to the state of the item's item class Obsolete flag. Pass a null to not apply this filter option.
- excludedItems
- Optional. Holds a list of items that may not be picked from the tree. The items in this list will be shown, but the OK button will not be enabled if an item in the list is selected.
- itemID
- Output. Holds the item ID of the selected item.
- itemDesc
- Output. Holds the item description of the selected item.
- itemDisplay
- Output. Holds the selected item, in display format.
- itemClassID
- Output. Holds the item class ID of the selected item.
- itemClassDesc
- Output. Holds the item class description of the selected item.
- itemClassDisplay
- Output. Holds the item class, in display format, of the selected item.
- includeEmptyNode
- Required. Holds a flag that , if set to true, specifies that an empty node be included at the beginning of the tree to allow the user to choose 'No Item'.