VisListViewDropDown

PPJ.Runtime.Vis.VisListViewDropDown

Namespace: PPJ.Runtime.Vis

Assembly: PPJ.Web.Vis.49 (4.9.0.0)

Combobox with dropdown cListView

public class VisListViewDropDown : VisDropDownBase

Constructors

VisListViewDropDown()

Methods

AddImage(hpicLarge, hpicSmall)

Adds an image to control's internal ImageLists at the index specified.

Parameter
Type
Description

hpicLarge

hpicSmall

Returns: SalNumber.

Arrange(nCode)

Aligns items on a grid.

Parameter
Type
Description

Returns: SalBoolean.

AssignColumns(saTitles, naAlignments, naWidths, nNumColumns)

Assigns columns to be used for 'details' view. TIP: You can reassign columns on the fly without having to repopulate the control. For instance, you can use SetItemText() to add four subitems to an item, but only assign four columns (remember: 1 item + 4 subitems = 5 columns,) thus giving you a hidden column that you can display later by assigning five columns.

Parameter
Type
Description

Returns: SalBoolean.

DeleteAllItems()

Removes all items from the control.

Returns: SalBoolean.

DeleteItem(nItem)

Removes an item from control and returns count of remaining items.

Parameter
Type
Description

Returns: SalNumber.

EnsureVisible(nItem, fPartialOK)

Ensures that an item is visible

Parameter
Type
Description

fPartialOK

Returns: SalBoolean.

FindItem(nFlags, sItemText, nItemStart)

Searches for an item by text or position.

Parameter
Type
Description

nFlags

sItemText

nItemStart

Returns: SalNumber.

FromHandle(hWnd)

Returns the control associated with the handle.

Parameter
Type
Description

Returns: VisListViewDropDown.

GetAllSelectedItems(naSelections)

Retrieves array of all selected items and returns count.

Parameter
Type
Description

Returns: SalNumber.

GetBkColor()

Retrieves the color used for the control's overall background.

Returns: SalNumber.

GetColumn(nColumn, sTitle, nAlignment, nWidth)

Parameter
Type
Description

nColumn

nAlignment

Returns: SalBoolean.

GetColumnAlignment(nColumn)

Parameter
Type
Description

nColumn

Returns: SalNumber.

GetColumnTitle(nColumn)

Retrieves a column's text.

Parameter
Type
Description

nColumn

Returns: SalString.

GetColumnWidth(nColumn)

Retrieves a column's width.

Parameter
Type
Description

nColumn

Returns: SalNumber.

GetCountPerPage()

Calculates the number of items that can fit vertically in control.

Returns: SalNumber.

GetEditable()

Returns: SalBoolean.

GetFocusItem()

Retrieves index of item with input focus.

Returns: SalNumber.

GetImageCount()

Retrieves the number of images in control. TIP: Remember that a listview defaults to one image (Windows logo) unless you remove/replace it.

Returns: SalNumber.

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

Parameter
Type
Description

nSubItem

sItemText

nItemValue

Returns: SalBoolean.

GetItemCount()

Retrieves the number of items in control.

Returns: SalNumber.

GetItemPosition(nItem, ptPosition)

Parameter
Type
Description

ptPosition

Returns: SalBoolean.

GetItemRect(nItem, rcItem)

Parameter
Type
Description

Returns: SalBoolean.

GetItemState(nItem, nMask)

Retrieves an item's state.

Parameter
Type
Description

Returns: SalNumber.

GetItemText(nItem, nSubItem)

Retrieves an item's text.

Parameter
Type
Description

nSubItem

Returns: SalString.

GetItemValue(nItem)

Retrieves an item's user data.

Parameter
Type
Description

Returns: SalNumber.

GetNextItem(nItem, nFlags)

Searches for an item by sequence, relation or state.

Parameter
Type
Description

Returns: SalNumber.

GetSelectedCount()

Retrieves the number of selected items in control.

Returns: SalNumber.

GetSelectedItem()

Returns: SalNumber.

GetSortColumn()

Retrieves default sort column (subitem.)

Returns: SalNumber.

GetSortOrder()

Retrieves default sort order (ascending/descending)

Returns: SalNumber.

GetStringWidth(sCompare)

Determines the minimum column width necessary to display all of a given string.

Parameter
Type
Description

sCompare

Returns: SalNumber.

GetTextBkColor()

Retrieves the color used for item and subitem text background.

Returns: SalNumber.

GetTextColor()

Retrieves the color used for item and subitem text.

Returns: SalNumber.

GetTopIndex()

Retrieves the index of the topmost visible item.

Returns: SalNumber.

InsertDetails(nItem, saText, nImage)

Inserts a new item into control and supplies subitem text for item. TIP: Use this instead of the InsertItem*() functions to specify items with multiple columns in one function call when you already have your data populated in an array.

Parameter
Type
Description

Returns: SalNumber.

InsertDetailsPic(nItem, saText, hpicLarge, hpicSmall)

Parameter
Type
Description

Returns: SalNumber.

InsertDetailsValue(nItem, saText, nItemValue, nImage)

Inserts a new item into control and supplies subitem text for item; also assigns user data for item.

Parameter
Type
Description

Returns: SalNumber.

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

Parameter
Type
Description

nItemValue

hpicLarge

hpicSmall

Returns: SalNumber.

InsertItem(nItem, sText, nImage)

Inserts an item in control and returns index of new item or -1 if unsuccessful. TIP: Do not assume that the item you add with InsertItem() is given the index you requested; InsertItem() returns the actual index of the item added. If you insert past the upper bound of the control, your item is added to the end.

Parameter
Type
Description

Returns: SalNumber.

InsertItemPic(nItem, sText, hpicLarge, hpicSmall)

Parameter
Type
Description

hpicLarge

hpicSmall

Returns: SalNumber.

InsertItemValue(nItem, sText, nItemValue, nImage)

Inserts a new item in control and assigns user data for item. Returns index of new item or -1 if unsuccessful.

Parameter
Type
Description

nItemValue

nImage

Returns: SalNumber.

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

Parameter
Type
Description

nItemValue

hpicLarge

hpicSmall

Returns: SalNumber.

RemoveAllImages()

Removes all images from control.

Returns: SalBoolean.

RemoveImage(nIndex)

Removes an image from control's internal ImageLists. TIP: All other images will shift downward when you remove an image from the control. Bear in mind that this will affect the images each item displays, since images are references by position.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

ReplaceImage(nIndex, hpicLarge, hpicSmall)

Replaces an image in control's internal ImageLists.

Parameter
Type
Description

nIndex

hpicLarge

hpicSmall

Returns: SalBoolean.

SetBkColor(nNewColor)

Assigns the color used for the control's overall background.

Parameter
Type
Description

nNewColor

Returns: SalBoolean.

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

Sets the attributes of a column.

Parameter
Type
Description

nColumn

sTitle

nAlignment

nWidth

Returns: SalBoolean.

SetColumnAlignment(nColumn, nAlignment)

Parameter
Type
Description

nColumn

nAlignment

Returns: SalBoolean.

SetColumnTitle(nColumn, sTitle)

Sets a column's text.

Parameter
Type
Description

nColumn

sTitle

Returns: SalBoolean.

SetColumnWidth(nColumn, nWidth)

Sets a column's width.

Parameter
Type
Description

nColumn

nWidth

Returns: SalBoolean.

SetEditable(fEditable)

Parameter
Type
Description

fEditable

Returns: SalBoolean.

SetFocusItem(nItem)

Assigns focus to the specified item.

Parameter
Type
Description

Returns: SalBoolean.

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

Sets an item's attributes.

Parameter
Type
Description

nSubItem

sItemText

nItemValue

nImage

Returns: SalBoolean.

SetItemState(nItem, nNewState, nStateMask)

Assigns an item's state (LVIS_Focused, LVIS_Selected, etc..)

Parameter
Type
Description

nNewState

nStateMask

Returns: SalBoolean.

SetItemText(nItem, nSubItem, sItemText)

Sets an item's or subitem's text. TIP: When using this function to assign subitem text for new items, do not assume that the item you just added with InsertItem() was given the index you requested; InsertItem() returns the actual index of the item, use that value.

Parameter
Type
Description

nSubItem

sItemText

Returns: SalBoolean.

SetItemValue(nItem, nItemValue)

Assigns an item's user data.

Parameter
Type
Description

nItemValue

Returns: SalBoolean.

SetListSize(nWidth, nHeight)

Parameter
Type
Description

nWidth

nHeight

Returns: SalBoolean.

SetSortColumn(nColumn)

Assigns default column (subitem) to sort on.

Parameter
Type
Description

nColumn

Returns: SalBoolean.

SetSortOrder(nOrder)

Assigns default sort order (LVSORT_Ascending/LVSORT_Descending.)

Parameter
Type
Description

nOrder

Returns: SalBoolean.

SetStyle(nStyle, fOn)

Sets style bits for control.

Parameter
Type
Description

Returns: SalNumber.

SetTextBkColor(nNewColor)

Assigns the color used for item and subitem text background.

Parameter
Type
Description

nNewColor

Returns: SalBoolean.

SetTextColor(nNewColor)

Assigns the color used for item and subitem text.

Parameter
Type
Description

nNewColor

Returns: SalBoolean.

SortItems()

Sorts the items based on default column (subitem) and order settings.

Returns: SalBoolean.

ViewDetails()

Tells control to display 'details' view.' This view is similar to the 'small icon' view, with the exception that subitem text is also displayed in resizable, sortable columns to the right of the item text. NOTE: Clicking on subitem text does NOT change focus,

Returns: SalNumber.

ViewLargeIcons()

Tells control to display 'large icons' view. This view is similar to Windows' program manager groups; a large icon is displayed with the item text underneath.

Returns: SalNumber.

ViewSmallIcons()

Tells control to display 'small icons' view. This view is a vertical list of item text with a small icon to the left of each item.

Returns: SalNumber.

Implements

Last updated