VisListViewDropDown

Namespace: PPJ.Runtime.Vis

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

Combo box with drop down cListView

C#

public class VisListViewDropDown : VisDropDownBase

VB.NET

Public Class VisListViewDropDown
    Inherits VisDropDownBase

Constructors

VisListViewDropDown()

Constructor

Methods

AddImage(hpicLarge, hpicSmall)

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

Parameter	Type	Description
hpicLarge	SalNumber
hpicSmall	SalNumber

Returns: SalNumber.

Arrange(nCode)

Aligns items on a grid.

Parameter	Type	Description
nCode	SalNumber

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
saTitles	SalArray<SalString>
naAlignments	SalArray<SalNumber>
naWidths	SalArray<SalNumber>
nNumColumns	SalNumber

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
nItem	SalNumber

Returns: SalNumber.

EnsureVisible(nItem, fPartialOK)

Ensures that an item is visible

Parameter	Type	Description
nItem	SalNumber
fPartialOK	SalBoolean

Returns: SalBoolean.

FindItem(nFlags, sItemText, nItemStart)

Searches for an item by text or position.

Parameter	Type	Description
nFlags	SalNumber
sItemText	SalString
nItemStart	SalNumber

Returns: SalNumber.

FromHandle(handle)

Returns the control associated with the handle.

Parameter	Type	Description
handle	SalWindowHandle

Returns: VisListViewDropDown.

GetAllSelectedItems(naSelections)

Retrieves array of all selected items and returns count.

Parameter	Type	Description
naSelections	SalArray<SalNumber>

Returns: SalNumber.

GetBkColor()

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

Returns: SalNumber.

GetColumn(nColumn, sTitle, nAlignment, nWidth)

Parameter	Type	Description
nColumn	SalNumber
sTitle	SalString&
nAlignment	SalNumber&
nWidth	SalNumber&

Returns: SalBoolean.

GetColumnAlignment(nColumn)

Parameter	Type	Description
nColumn	SalNumber

Returns: SalNumber.

GetColumnTitle(nColumn)

Retrieves a column's text.

Parameter	Type	Description
nColumn	SalNumber

Returns: SalString.

GetColumnWidth(nColumn)

Retrieves a column's width.

Parameter	Type	Description
nColumn	SalNumber

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
nItem	SalNumber
nSubItem	SalNumber
sItemText	SalString&
nItemValue	SalNumber&
nImage	SalNumber&

Returns: SalBoolean.

GetItemCount()

Retrieves the number of items in control.

Returns: SalNumber.

GetItemPosition(nItem, ptPosition)

Retrieves the position of an item.

Parameter	Type	Description
nItem	SalNumber
ptPosition	VisPoint

Returns: SalBoolean.

GetItemRect(nItem, rcItem, nCode)

Retrieves the bounding rectangle for an item.

Parameter	Type	Description
nItem	SalNumber
rcItem	VisRect
nCode	SalNumber

Returns: SalBoolean.

GetItemState(nItem, nMask)

Retrieves an item's state.

Parameter	Type	Description
nItem	SalNumber
nMask	SalNumber

Returns: SalNumber.

GetItemText(nItem, nSubItem)

Retrieves an item's text.

Parameter	Type	Description
nItem	SalNumber
nSubItem	SalNumber

Returns: SalString.

GetItemValue(nItem)

Retrieves an item's user data.

Parameter	Type	Description
nItem	SalNumber

Returns: SalNumber.

GetNextItem(nItem, nFlags)

Searches for an item by sequence, relation or state.

Parameter	Type	Description
nItem	SalNumber
nFlags	SalNumber

Returns: SalNumber.

GetOrigin(ptOrigin)

Retrieves the current view origin for control.

Parameter	Type	Description
ptOrigin	VisPoint

Returns: SalBoolean.

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	SalString

Returns: SalNumber.

GetStyle()

Retrieves current style bits for control.

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.

GetViewRect(rcView)

Retrieves the bounding rectangle of all items in the control.

Parameter	Type	Description
rcView	VisRect

Returns: SalBoolean.

HitTest(ptTest, nFlags)

Parameter	Type	Description
ptTest	VisPoint
nFlags	SalNumber&

Returns: SalNumber.

HitTest(nX, nY, nFlags)

Parameter	Type	Description
nX	SalNumber
nY	SalNumber
nFlags	SalNumber&

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
nItem	SalNumber
saText	SalArray<SalString>
nImage	SalNumber

Returns: SalNumber.

InsertDetailsPic(nItem, saText, hpicLarge, hpicSmall)

Inserts a new item in control, copies picture into control and uses copy for new item. TIP: You should use AddImage() & InsertDetails() where possible to avoid duplicate images being stored.

Parameter	Type	Description
nItem	SalNumber
saText	SalArray<SalString>
hpicLarge	SalNumber
hpicSmall	SalNumber

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
nItem	SalNumber
saText	SalArray<SalString>
nItemValue	SalNumber
nImage	SalNumber

Returns: SalNumber.

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

Inserts a new item into control and supplies subitem text for item; also assigns user data for item. TIP: You should use AddImage() and InsertDetailsValue() where possible to avoid duplicate images being stored.

Parameter	Type	Description
nItem	SalNumber
saText	SalArray<SalString>
nItemValue	SalNumber
hpicLarge	SalNumber
hpicSmall	SalNumber

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
nItem	SalNumber
sText	SalString
nImage	SalNumber

Returns: SalNumber.

InsertItemPic(nItem, sText, hpicLarge, hpicSmall)

Inserts a new item in control, copies picture into control and uses copy for new item. Returns index of new item or -1 if unsuccessful. TIP: You should use AddImage() and InsertItem() where possible to avoid duplicate images being stored.

Parameter	Type	Description
nItem	SalNumber
sText	SalString
hpicLarge	SalNumber
hpicSmall	SalNumber

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
nItem	SalNumber
sText	SalString
nItemValue	SalNumber
nImage	SalNumber

Returns: SalNumber.

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

Inserts a new item in control, copies picture into control and uses copy for new item. Also assigns user data for item. Returns index of new item or -1 if unsuccessful. TIP: You should use AddImage() and InsertItemValue() where possible to avoid duplicate images being stored.

Parameter	Type	Description
nItem	SalNumber
sText	SalString
nItemValue	SalNumber
hpicLarge	SalNumber
hpicSmall	SalNumber

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	SalNumber

Returns: SalBoolean.

ReplaceImage(nIndex, hpicLarge, hpicSmall)

Replaces an image in control's internal ImageLists.

Parameter	Type	Description
nIndex	SalNumber
hpicLarge	SalNumber
hpicSmall	SalNumber

Returns: SalBoolean.

Scroll(size)

Scrolls the contents of control.

Parameter	Type	Description
size	VisSize

Returns: SalBoolean.

SetBkColor(nNewColor)

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

Parameter	Type	Description
nNewColor	SalNumber

Returns: SalBoolean.

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

Sets the attributes of a column.

Parameter	Type	Description
nColumn	SalNumber
nMask	SalNumber
sTitle	SalString
nAlignment	SalNumber
nWidth	SalNumber

Returns: SalBoolean.

SetColumnAlignment(nColumn, nAlignment)

Parameter	Type	Description
nColumn	SalNumber
nAlignment	SalNumber

Returns: SalBoolean.

SetColumnTitle(nColumn, sTitle)

Sets a column's text.

Parameter	Type	Description
nColumn	SalNumber
sTitle	SalString

Returns: SalBoolean.

SetColumnWidth(nColumn, nWidth)

Sets a column's width.

Parameter	Type	Description
nColumn	SalNumber
nWidth	SalNumber

Returns: SalBoolean.

SetEditable(fEditable)

Parameter	Type	Description
fEditable	SalBoolean

Returns: SalBoolean.

SetFocusItem(nItem)

Assigns focus to the specified item.

Parameter	Type	Description
nItem	SalNumber

Returns: SalBoolean.

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

Sets an item's attributes.

Parameter	Type	Description
nItem	SalNumber
nSubItem	SalNumber
nMask	SalNumber
sItemText	SalString
nItemValue	SalNumber
nImage	SalNumber

Returns: SalBoolean.

SetItemPosition(nItem, ptPosition)

Moves an item to a specified position in control.

Parameter	Type	Description
nItem	SalNumber
ptPosition	VisPoint

Returns: SalBoolean.

SetItemState(nItem, nNewState, nStateMask)

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

Parameter	Type	Description
nItem	SalNumber
nNewState	SalNumber
nStateMask	SalNumber

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
nItem	SalNumber
nSubItem	SalNumber
sItemText	SalString

Returns: SalBoolean.

SetItemValue(nItem, nItemValue)

Assigns an item's user data.

Parameter	Type	Description
nItem	SalNumber
nItemValue	SalNumber

Returns: SalBoolean.

SetListSize(nWidth, nHeight)

Parameter	Type	Description
nWidth	SalNumber
nHeight	SalNumber

Returns: SalBoolean.

SetSortColumn(nColumn)

Assigns default column (subitem) to sort on.

Parameter	Type	Description
nColumn	SalNumber

Returns: SalBoolean.

SetSortOrder(nOrder)

Assigns default sort order (LVSORT_Ascending/LVSORT_Descending.)

Parameter	Type	Description
nOrder	SalNumber

Returns: SalBoolean.

SetStyle(nStyle, fOn)

Sets style bits for control.

Parameter	Type	Description
nStyle	SalNumber
fOn	SalBoolean

Returns: SalNumber.

SetTextBkColor(nNewColor)

Assigns the color used for item and subitem text background.

Parameter	Type	Description
nNewColor	SalNumber

Returns: SalBoolean.

SetTextColor(nNewColor)

Assigns the color used for item and subitem text.

Parameter	Type	Description
nNewColor	SalNumber

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 resizeable, 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.

ViewList()

Tells control to display 'list' view. This view is similar to the 'small icon' view, with the exception that rather than exceed the vertical display space, the list is broken into multiple screens, or 'columns.'

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

Name	Description
ISalControl
ISalEditControl
ISalListControl
ISalWindow