VisListView
Namespace: PPJ.Runtime.Vis
Assembly: PPJ.Runtime.Vis.49 (4.9.0.0)
ListView control
- C#
- VB.NET
public class VisListView : ListView, ISalWindow
Public Class VisListView
Inherits ListView
Implements ISalWindow
Constructors
VisListView()
Default Constructor.
Properties
NamedProperties
SalNamedProperties: Returns the collection of named properties.
RightToLeftLayout
Boolean: Overrides RightToLeftLayout to implement the inheritance from the parent form. (Default: False)
Methods
AddImage(hpicLarge, hpicSmall)
Adds an image to control's internal ImageLists.
| Parameter | Type | Description |
|---|---|---|
| hpicLarge | SalNumber | |
| hpicSmall | SalNumber |
Returns: SalNumber.
Arrange(code)
Aligns items on a grid.
| Parameter | Type | Description |
|---|---|---|
| code | SalNumber |
Returns: SalBoolean.
AssignColumns(saTitles, naAlignments, naWidths, nNumColumns)
Assigns columns to be used for 'details' view.
| Parameter | Type | Description |
|---|---|---|
| saTitles | SalArray<SalString> | |
| naAlignments | SalArray<SalNumber> | |
| naWidths | SalArray<SalNumber> | |
| nNumColumns | SalNumber |
Returns: SalBoolean.
BringWindowToTop()
Brings a window to the top of all overlapping windows.
Returns: SalBoolean.
CenterWindow()
Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.
Returns: SalBoolean.
ClearCursor(type)
Clears a window's cursor.
| Parameter | Type | Description |
|---|---|---|
| type | 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.
DestroyWindow()
Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.
Returns: SalBoolean.
DisableWindow()
Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.
Returns: SalBoolean.
EnableWindow()
Enables keyboard and mouse input to a window.
Returns: SalBoolean.
EnsureVisible(item, partialOK)
Ensures that an item is visible
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| partialOK | SalBoolean |
Returns: SalBoolean.
FindChild(windowName)
This function finds a child window of a given name in the specified window.
| Parameter | Type | Description |
|---|---|---|
| windowName | SalString |
Returns: SalWindowHandle.
FindItem(flags, itemText, itemStart)
Searches for an item by text or position.
| Parameter | Type | Description |
|---|---|---|
| flags | SalNumber | |
| itemText | SalString | |
| itemStart | SalNumber |
Returns: SalNumber.
FormUnitsToPixels(formUnits, vertical)
Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.
| Parameter | Type | Description |
|---|---|---|
| formUnits | SalNumber | The number of form units. |
| vertical | SalBoolean | If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE. |
Returns: SalNumber.
FromHandle(handle)
Returns the control associated with the handle.
| Parameter | Type | Description |
|---|---|---|
| handle | SalWindowHandle |
Returns: VisListView.
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.
GetClassName()
Return the name of a window's class as a string.
Returns: SalString.
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.
GetControlType()
Returns an object's type.
Returns: SalNumber.
GetCountPerPage()
Calculates the number of items that can fit vertically in control.
Returns: SalNumber.
GetFirstChild(typeMask)
Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.
| Parameter | Type | Description |
|---|---|---|
| typeMask | SalNumber | One or more window types combined (using the OR (|) operator) to create a mask of child window types. |
Returns: SalWindowHandle.
GetFocusItem()
Retrieves index of item with input focus.
Returns: SalNumber.
GetFont(name, size, enhancement)
| Parameter | Type | Description |
|---|---|---|
| name | SalString& | |
| size | SalNumber& | |
| enhancement | SalNumber& |
Returns: SalBoolean.
GetImageCount()
Retrieves the number of images in control.
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(item, position)
Retrieves the position of an item.
| Parameter | Type | Description |
|---|---|---|
| item | SalNumber | |
| position | 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.
GetLocation(x, y)
| Parameter | Type | Description |
|---|---|---|
| x | SalNumber& | |
| y | SalNumber& |
Returns: SalBoolean.
GetName(text)
| Parameter | Type | Description |
|---|---|---|
| text | SalString& |
Returns: SalBoolean.
GetName()
Gets the name of an object.
Returns: SalString.
GetNextChild(typeMask)
Returns the handle of the next child window that matches a specified type.
| Parameter | Type | Description |
|---|---|---|
| typeMask | SalNumber | One or more window types combined (using the OR (|) operator) to create a mask of child window types. |
Returns: SalWindowHandle.
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.
GetParent()
Returns the handle of an object's parent window.
Returns: SalWindowHandle.
GetProperty(name, value)
| Parameter | Type | Description |
|---|---|---|
| name | SalString | |
| value | SalString& |
Returns: SalBoolean.
GetProperty(name)
Gets the value of a named property.
| Parameter | Type | Description |
|---|---|---|
| name | SalString |
Returns: SalString.
GetSelectedCount()
Retrieves the number of selected items in control.
Returns: SalNumber.
GetSelectedItem()
Returns: SalNumber.
GetSize(width, height)
| Parameter | Type | Description |
|---|---|---|
| width | SalNumber& | |
| height | SalNumber& |
Returns: SalBoolean.
GetSortColumn()
Retrieves default sort column (sub item.)
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.
GetText(text, maxLen)
| Parameter | Type | Description |
|---|---|---|
| text | SalString& | |
| maxLen | SalNumber |
Returns: SalNumber.
GetText(maxLen)
Retrieves the text of a window.
| Parameter | Type | Description |
|---|---|---|
| maxLen | SalNumber |
Returns: SalString.
GetTextBkColor()
Retrieves the color used for item and sub item text background.
Returns: SalNumber.
GetTextColor()
Retrieves the color used for item and sub item 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.
GetWindowColor(colorIndex)
Gets a window's color.
| Parameter | Type | Description |
|---|---|---|
| colorIndex | SalNumber |
Returns: SalNumber.
GetWindowState()
Returns a window's current state.
Returns: SalNumber.
HideWindow()
Hides a window.
Returns: SalBoolean.
HitTest(ptTest, flags)
| Parameter | Type | Description |
|---|---|---|
| ptTest | VisPoint | |
| flags | SalNumber& |
Returns: SalNumber.
HitTest(x, y, flags)
| Parameter | Type | Description |
|---|---|---|
| x | SalNumber | |
| y | SalNumber | |
| flags | SalNumber& |
Returns: SalNumber.
InsertDetails(nItem, saText, nImage)
Inserts a new item into control and supplies sub item text for item.
| 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.
| 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 sub item 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 sub item text for item; also assigns user data for item.
| 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.
| 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.
| 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.
| Parameter | Type | Description |
|---|---|---|
| nItem | SalNumber | |
| sText | SalString | |
| nItemValue | SalNumber | |
| hpicLarge | SalNumber | |
| hpicSmall | SalNumber |
Returns: SalNumber.
InvalidateWindow()
Causes a window to be repainted.
Returns: SalBoolean.
IsDerivedFromClass(typeClass)
Determines whether a window is an instance of the specified class.
| Parameter | Type | Description |
|---|---|---|
| typeClass | Type |
Returns: SalBoolean.
IsEnabled()
Determines whether a window is enabled for mouse and keyboard input.
Returns: SalBoolean.
IsVisible()
Determines whether a window is currently visible.
Returns: SalBoolean.
KillTimer(idEvent)
Destroys an object's system timer.
| Parameter | Type | Description |
|---|---|---|
| idEvent | SalNumber |
Returns: SalBoolean.
MoveWindow(xOffset, yOffset)
Moves a window a given number of form units on the X and Y axes relative to its current position.
| Parameter | Type | Description |
|---|---|---|
| xOffset | SalNumber | |
| yOffset | SalNumber |
Returns: SalBoolean.
PixelsToFormUnits(numPixels, vertical)
Computes the number of form units based on the number of pixels. Form units are a unit of measurement used by functions that move and position objects. Form units are computed using physical units (pixels) in conjunction with a window's font sizes.
| Parameter | Type | Description |
|---|---|---|
| numPixels | SalNumber | |
| vertical | SalBoolean | If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE. |
Returns: SalNumber.
PostMessage(msg, mywParam, mylParam)
Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.
| Parameter | Type | Description |
|---|---|---|
| msg | SalNumber | |
| mywParam | SalNumber | |
| mylParam | SalNumber |
Returns: SalBoolean.
RemoveAllImages()
Removes all images from control.
Returns: SalBoolean.
RemoveImage(nIndex)
Removes an image from control's internal ImageLists.
| 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.
SendMessage(msg, mywParam, mylParam)
Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.
| Parameter | Type | Description |
|---|---|---|
| msg | SalNumber | |
| mywParam | SalNumber | |
| mylParam | SalNumber |
Returns: SalNumber.
SendMessageToChildren(nMsg, nMywParam, nMylParam)
Sends a message to all child items of a form window, dialog box, table window, or MDI window.
| Parameter | Type | Description |
|---|---|---|
| nMsg | SalNumber | |
| nMywParam | SalNumber | |
| nMylParam | SalNumber |
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.
SetContextMenu(sMenuName, nFlags)
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
| Parameter | Type | Description |
|---|---|---|
| sMenuName | SalString | |
| nFlags | SalNumber |
Returns: SalBoolean.
SetContextMenu(menuType, flags)
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
| Parameter | Type | Description |
|---|---|---|
| menuType | Type | |
| flags | SalNumber |
Returns: SalBoolean.
SetCursor(resource, type)
Sets a window's cursor.
| Parameter | Type | Description |
|---|---|---|
| resource | SalResourceCursor | |
| type | SalNumber |
Returns: SalBoolean.
SetCursor(resourceId, type)
Sets a window's cursor.
| Parameter | Type | Description |
|---|---|---|
| resourceId | Int32 | |
| type | SalNumber |
Returns: SalBoolean.
SetCursor(blob, type)
Sets a window's cursor from a string variable.
| Parameter | Type | Description |
|---|---|---|
| blob | SalString | |
| type | SalNumber |
Returns: SalBoolean.
SetCursorFile(file, type)
Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.
| Parameter | Type | Description |
|---|---|---|
| file | SalString | |
| type | SalNumber |
Returns: SalBoolean.
SetFocus()
Sets the focus to a specified window.
Returns: SalWindowHandle.
SetFocusItem(nItem)
Assigns focus to the specified item.
| Parameter | Type | Description |
|---|---|---|
| nItem | SalNumber |
Returns: SalBoolean.
SetFont(name, size, enhancement)
Sets a window's font, font size, and font enhancements.
| Parameter | Type | Description |
|---|---|---|
| name | SalString | |
| size | SalNumber | |
| enhancement | 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(item, ptPosition)
Moves an item to a specified position in control.
| Parameter | Type | Description |
|---|---|---|
| item | 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 sub item's text.
| 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.
SetLocation(x, y)
Moves a window to a new position (x, y) on the X and Y axes.
| Parameter | Type | Description |
|---|---|---|
| x | SalNumber | |
| y | SalNumber |
Returns: SalBoolean.
SetProperty(name, value, length)
Sets the value of a named property.
| Parameter | Type | Description |
|---|---|---|
| name | SalString | |
| value | SalString | |
| length | SalNumber |
Returns: SalBoolean.
SetSize(width, height)
Resizes a window.
| Parameter | Type | Description |
|---|---|---|
| width | SalNumber | |
| height | SalNumber |
Returns: SalBoolean.
SetSortColumn(nColumn)
Assigns default column (sub item) 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.
SetText(text)
Sets the text of a window.
| Parameter | Type | Description |
|---|---|---|
| text | SalString |
Returns: SalBoolean.
SetTextBkColor(nNewColor)
Assigns the color used for item and sub item text background.
| Parameter | Type | Description |
|---|---|---|
| nNewColor | SalNumber |
Returns: SalBoolean.
SetTextColor(nNewColor)
Assigns the color used for item and sub item text.
| Parameter | Type | Description |
|---|---|---|
| nNewColor | SalNumber |
Returns: SalBoolean.
SetTimer(idEvent, elapseMilliSec)
Creates a system timer for a given object. When a timer event occurs, sends SAM_Timer messages to the object in specified intervals. Timers are a limited global resource. Your application must check the value returned by SalTimerSet to verify that the timer was created.
| Parameter | Type | Description |
|---|---|---|
| idEvent | SalNumber | |
| elapseMilliSec | SalNumber |
Returns: SalBoolean.
SetWindowColor(colorIndex, color)
Sets a window's color.
| Parameter | Type | Description |
|---|---|---|
| colorIndex | SalNumber | |
| color | SalNumber |
Returns: SalBoolean.
ShowWindow()
Makes a window visible.
Returns: SalBoolean.
SortItems()
Sorts the items.
Returns: SalBoolean.
TrackPopupMenu(menuName, flags, x, y)
Creates pop-up menus at runtime.
| Parameter | Type | Description |
|---|---|---|
| menuName | SalString | |
| flags | SalNumber | |
| x | SalNumber | |
| y | SalNumber |
Returns: SalBoolean.
TrackPopupMenu(menuType, flags, x, y)
Creates pop-up menus at runtime.
| Parameter | Type | Description |
|---|---|---|
| menuType | Type | |
| flags | SalNumber | |
| x | SalNumber | |
| y | SalNumber |
Returns: SalBoolean.
UpdateWindow()
Forces the update of a window.
Returns: SalBoolean.
ViewDetails()
Tells control to display 'details' view.'
Returns: SalNumber.
ViewLargeIcons()
Tells control to display 'large icons' view.
Returns: SalNumber.
ViewList()
Tells control to display 'list' view.
Returns: SalNumber.
ViewSmallIcons()
Tells control to display 'small icons' view.
Returns: SalNumber.
WinHelp(file, command, numData, strData)
Starts the Windows help system.
| Parameter | Type | Description |
|---|---|---|
| file | SalString | |
| command | SalNumber | |
| numData | SalNumber | |
| strData | SalString |
Returns: SalBoolean.
Yield()
Processes messages for this control.
Events
MessageActions
SalMessageHandler Message Actions
WindowActions
WindowActionsEventHandler Window Actions
Implements
| Name | Description |
|---|---|
| ISalWindow |