Skip to main content
Version: 2025

VisListViewDropDown

Namespace: PPJ.Runtime.Vis

Assembly: PPJ.Web.Vis.50 (5.0.0.0)

A combo-style field whose popup is a Visual Toolchest list view.

public class VisListViewDropDown : VisDropDownBase

Item, image, column, and sorting operations delegate to the popup list view.

Example:

var choices = new VisListViewDropDown();
choices.InsertItemValue(0, "Standard", 1, -1);
choices.InsertItemValue(1, "Express", 2, -1);

Constructors

Instance member VisListViewDropDown()

Creates a borderless large-icon list view as the popup and attaches selection and click handlers.

Methods

Instance member AddImage(hpicLarge, hpicSmall)

ParameterTypeDescription
hpicLargeSalNumber
hpicSmallSalNumber

Returns: SalNumber.

Instance member Arrange(nCode)

ParameterTypeDescription
nCodeSalNumber

Returns: SalBoolean.

Instance member AssignColumns(saTitles, naAlignments, naWidths, nNumColumns)

ParameterTypeDescription
saTitlesSalArray<SalString>
naAlignmentsSalArray<SalNumber>
naWidthsSalArray<SalNumber>
nNumColumnsSalNumber

Returns: SalBoolean.

Instance member DeleteAllItems()

Returns: SalBoolean.

Instance member DeleteItem(nItem)

ParameterTypeDescription
nItemSalNumber

Returns: SalNumber.

Instance member EnsureVisible(nItem, fPartialOK)

ParameterTypeDescription
nItemSalNumber
fPartialOKSalBoolean

Returns: SalBoolean.

Instance member FindItem(nFlags, sItemText, nItemStart)

ParameterTypeDescription
nFlagsSalNumber
sItemTextSalString
nItemStartSalNumber

Returns: SalNumber.

Static member FromHandle(hWnd)

Resolves a SAL handle to an existing VisListViewDropDown.

ParameterTypeDescription
hWndSalWindowHandleThe control handle to resolve.

Returns: VisListViewDropDown. The associated control, or when no control is resolved.

Throws:

Instance member GetAllSelectedItems(naSelections)

ParameterTypeDescription
naSelectionsSalArray<SalNumber>

Returns: SalNumber.

Instance member GetBkColor()

Returns: SalNumber.

Instance member GetColumn(nColumn, sTitle, nAlignment, nWidth)

ParameterTypeDescription
nColumnSalNumber
sTitle by referenceSalString
nAlignment by referenceSalNumber
nWidth by referenceSalNumber

Returns: SalBoolean.

Instance member GetColumnAlignment(nColumn)

ParameterTypeDescription
nColumnSalNumber

Returns: SalNumber.

Instance member GetColumnTitle(nColumn)

ParameterTypeDescription
nColumnSalNumber

Returns: SalString.

Instance member GetColumnWidth(nColumn)

ParameterTypeDescription
nColumnSalNumber

Returns: SalNumber.

Instance member GetCountPerPage()

Returns: SalNumber.

Instance member GetEditable()

Returns the compatibility editability setting.

Returns: SalBoolean. Always false; this query is not implemented.

Instance member GetFocusItem()

Returns: SalNumber.

Instance member GetImageCount()

Returns: SalNumber.

Instance member GetItem(nItem, nSubItem, sItemText, nItemValue, nImage)

ParameterTypeDescription
nItemSalNumber
nSubItemSalNumber
sItemText by referenceSalString
nItemValue by referenceSalNumber
nImage by referenceSalNumber

Returns: SalBoolean.

Instance member GetItemCount()

Returns: SalNumber.

Instance member GetItemPosition(nItem, ptPosition)

ParameterTypeDescription
nItemSalNumber
ptPosition by referenceVisPoint

Returns: SalBoolean.

Instance member GetItemRect(nItem, rcItem)

ParameterTypeDescription
nItemSalNumber
rcItem by referenceVisRect

Returns: SalBoolean.

Instance member GetItemState(nItem, nMask)

ParameterTypeDescription
nItemSalNumber
nMaskSalNumber

Returns: SalNumber.

Instance member GetItemText(nItem, nSubItem)

ParameterTypeDescription
nItemSalNumber
nSubItemSalNumber

Returns: SalString.

Instance member GetItemValue(nItem)

ParameterTypeDescription
nItemSalNumber

Returns: SalNumber.

Instance member GetNextItem(nItem, nFlags)

ParameterTypeDescription
nItemSalNumber
nFlagsSalNumber

Returns: SalNumber.

Instance member GetSelectedCount()

Returns: SalNumber.

Instance member GetSelectedItem()

Returns: SalNumber.

Instance member GetSortColumn()

Returns: SalNumber.

Instance member GetSortOrder()

Returns: SalNumber.

Instance member GetStringWidth(sCompare)

ParameterTypeDescription
sCompareSalString

Returns: SalNumber.

Instance member GetTextBkColor()

Returns: SalNumber.

Instance member GetTextColor()

Returns: SalNumber.

Instance member GetTopIndex()

Returns: SalNumber.

Instance member InsertDetails(nItem, saText, nImage)

ParameterTypeDescription
nItemSalNumber
saTextSalArray<SalString>
nImageSalNumber

Returns: SalNumber.

Instance member InsertDetailsPic(nItem, saText, hpicLarge, hpicSmall)

ParameterTypeDescription
nItemSalNumber
saTextSalArray<SalString>
hpicLargeSalNumber
hpicSmallSalNumber

Returns: SalNumber.

Instance member InsertDetailsValue(nItem, saText, nItemValue, nImage)

ParameterTypeDescription
nItemSalNumber
saTextSalArray<SalString>
nItemValueSalNumber
nImageSalNumber

Returns: SalNumber.

Instance member InsertDetailsValuePic(nItem, saText, nItemValue, hpicLarge, hpicSmall)

ParameterTypeDescription
nItemSalNumber
saTextSalArray<SalString>
nItemValueSalNumber
hpicLargeSalNumber
hpicSmallSalNumber

Returns: SalNumber.

Instance member InsertItem(nItem, sText, nImage)

ParameterTypeDescription
nItemSalNumber
sTextSalString
nImageSalNumber

Returns: SalNumber.

Instance member InsertItemPic(nItem, sText, hpicLarge, hpicSmall)

ParameterTypeDescription
nItemSalNumber
sTextSalString
hpicLargeSalNumber
hpicSmallSalNumber

Returns: SalNumber.

Instance member InsertItemValue(nItem, sText, nItemValue, nImage)

ParameterTypeDescription
nItemSalNumber
sTextSalString
nItemValueSalNumber
nImageSalNumber

Returns: SalNumber.

Instance member InsertItemValuePic(nItem, sText, nItemValue, hpicLarge, hpicSmall)

ParameterTypeDescription
nItemSalNumber
sTextSalString
nItemValueSalNumber
hpicLargeSalNumber
hpicSmallSalNumber

Returns: SalNumber.

Protected member OnFontChanged(e)

Raises the inherited event, then copies the field font to the popup list view.

ParameterTypeDescription
eEventArgsThe font-change event data.

Instance member RemoveAllImages()

Returns: SalBoolean.

Instance member RemoveImage(nIndex)

ParameterTypeDescription
nIndexSalNumber

Returns: SalBoolean.

Instance member ReplaceImage(nIndex, hpicLarge, hpicSmall)

ParameterTypeDescription
nIndexSalNumber
hpicLargeSalNumber
hpicSmallSalNumber

Returns: SalBoolean.

Instance member SetBkColor(nNewColor)

ParameterTypeDescription
nNewColorSalNumber

Returns: SalBoolean.

Instance member SetColumn(nColumn, nMask, sTitle, nAlignment, nWidth)

ParameterTypeDescription
nColumnSalNumber
nMaskSalNumber
sTitleSalString
nAlignmentSalNumber
nWidthSalNumber

Returns: SalBoolean.

Instance member SetColumnAlignment(nColumn, nAlignment)

ParameterTypeDescription
nColumnSalNumber
nAlignmentSalNumber

Returns: SalBoolean.

Instance member SetColumnTitle(nColumn, sTitle)

ParameterTypeDescription
nColumnSalNumber
sTitleSalString

Returns: SalBoolean.

Instance member SetColumnWidth(nColumn, nWidth)

ParameterTypeDescription
nColumnSalNumber
nWidthSalNumber

Returns: SalBoolean.

Instance member SetEditable(fEditable)

Accepts an editability request without changing the control.

ParameterTypeDescription
fEditableSalBooleanRequested editability; ignored.

Returns: SalBoolean. Always true.

Instance member SetFocusItem(nItem)

ParameterTypeDescription
nItemSalNumber

Returns: SalBoolean.

Instance member SetItem(nItem, nSubItem, nMask, sItemText, nItemValue, nImage)

ParameterTypeDescription
nItemSalNumber
nSubItemSalNumber
nMaskSalNumber
sItemTextSalString
nItemValueSalNumber
nImageSalNumber

Returns: SalBoolean.

Instance member SetItemState(nItem, nNewState, nStateMask)

ParameterTypeDescription
nItemSalNumber
nNewStateSalNumber
nStateMaskSalNumber

Returns: SalBoolean.

Instance member SetItemText(nItem, nSubItem, sItemText)

ParameterTypeDescription
nItemSalNumber
nSubItemSalNumber
sItemTextSalString

Returns: SalBoolean.

Instance member SetItemValue(nItem, nItemValue)

ParameterTypeDescription
nItemSalNumber
nItemValueSalNumber

Returns: SalBoolean.

Instance member SetListSize(nWidth, nHeight)

Accepts a popup-size request without changing the popup.

ParameterTypeDescription
nWidthSalNumberRequested width; ignored.
nHeightSalNumberRequested height; ignored.

Returns: SalBoolean. Always true.

Instance member SetSortColumn(nColumn)

ParameterTypeDescription
nColumnSalNumber

Returns: SalBoolean.

Instance member SetSortOrder(nOrder)

ParameterTypeDescription
nOrderSalNumber

Returns: SalBoolean.

Instance member SetStyle(nStyle, fOn)

ParameterTypeDescription
nStyleSalNumber
fOnSalBoolean

Returns: SalNumber.

Instance member SetTextBkColor(nNewColor)

ParameterTypeDescription
nNewColorSalNumber

Returns: SalBoolean.

Instance member SetTextColor(nNewColor)

ParameterTypeDescription
nNewColorSalNumber

Returns: SalBoolean.

Instance member SortItems()

Returns: SalBoolean.

Instance member ViewDetails()

Returns: SalNumber.

Instance member ViewLargeIcons()

Returns: SalNumber.

Instance member ViewSmallIcons()

Returns: SalNumber.

Implements

NameDescription
ISalControl
ISalEditControl
ISalListControl
ISalWindow