VisListView

PPJ.Runtime.Vis.VisListView

Namespace: PPJ.Runtime.Vis

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

ListView control

public class VisListView : ListView, ISalWindow

Constructors

VisListView()

Default Constructor.

Properties

NamedProperties

SalNamedProperties: Returns the collection of named properties.

Methods

AddImage(hpicLarge, hpicSmall)

Adds an image to control's internal ImageLists.

Parameter
Type
Description

hpicLarge

hpicSmall

Returns: SalNumber.

AssignColumns(saTitles, naAlignments, naWidths, nNumColumns)

Assigns columns to be used for 'details' view.

Parameter
Type
Description

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(nType)

Clears a window's cursor.

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.

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(nItem, fPartialOK)

Ensures that an item is visible

Parameter
Type
Description

fPartialOK

Returns: SalBoolean.

FindChild(sWindowName)

This function finds a child window of a given name in the specified window.

Parameter
Type
Description

sWindowName

Returns: SalWindowHandle.

FindItem(nFlags, sItemText, nItemStart)

Searches for an item by text or position.

Parameter
Type
Description

nFlags

sItemText

nItemStart

Returns: SalNumber.

FormUnitsToPixels(nFormUnits, bVertical)

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

nFormUnits

bVertical

Returns: SalNumber.

FromHandle(hWnd)

Returns the control associated with the handle.

Parameter
Type
Description

Returns: VisListView.

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.

GetClassName()

Return the name of a window's class as a string.

Returns: SalString.

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.

GetControlType()

Returns an object's type.

Returns: SalNumber.

GetFirstChild(nTypeMask)

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

nTypeMask

Returns: SalWindowHandle.

GetFocusItem()

Retrieves index of item with input focus.

Returns: SalNumber.

GetFont(sName, nSize, nEnhancement)

Parameter
Type
Description

nEnhancement

Returns: SalBoolean.

GetImageCount()

Retrieves the number of images in control.

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.

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.

GetLocation(nX, nY)

Parameter
Type
Description

Returns: SalBoolean.

GetName(sText)

Parameter
Type
Description

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(nTypeMask)

Returns the handle of the next child window that matches a specified type.

Parameter
Type
Description

nTypeMask

Returns: SalWindowHandle.

GetNextItem(nItem, nFlags)

Searches for an item by sequence, relation or state.

Parameter
Type
Description

Returns: SalNumber.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(sName, sValue)

Parameter
Type
Description

Returns: SalBoolean.

GetProperty(sName)

Gets the value of a named property.

Parameter
Type
Description

Returns: SalString.

GetSelectedCount()

Retrieves the number of selected items in control.

Returns: SalNumber.

GetSelectedItem()

Returns: SalNumber.

GetSize(nWidth, nHeight)

Parameter
Type
Description

Returns: SalBoolean.

GetSortColumn()

Retrieves default sort column (subitem.)

Returns: SalNumber.

GetSortOrder()

Retrieves default sort order (ascending/descending)

Returns: SalNumber.

GetText(sText, nMaxLen)

Parameter
Type
Description

Returns: SalNumber.

GetText(nMaxLen)

Retrieves the text of a window.

Parameter
Type
Description

nMaxLen

Returns: SalString.

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.

GetWindowColor(nColorIndex)

Gets a window's color.

Parameter
Type
Description

nColorIndex

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

HideWindow()

Hides a window.

Returns: SalBoolean.

InsertDetails(nItem, saText, nImage)

Inserts a new item into control and supplies subitem text for item.

Parameter
Type
Description

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

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)

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

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.

Parameter
Type
Description

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

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)

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

nItemValue

hpicLarge

hpicSmall

Returns: SalNumber.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(tClass)

Determines whether a window is an instance of the specified class.

Parameter
Type
Description

tClass

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(nIDEvent)

Destroys an object's system timer.

Parameter
Type
Description

nIDEvent

Returns: SalBoolean.

MoveWindow(nXOffset, nYOffset)

Moves a window a given number of form units on the X and Y axes relative to its current position.

Parameter
Type
Description

nXOffset

nYOffset

Returns: SalBoolean.

PixelsToFormUnits(nNumPixels, bVertical)

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

nNumPixels

bVertical

Returns: SalNumber.

PostMessage(nMsg, nMywParam, nMylParam)

Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.

Parameter
Type
Description

nMywParam

nMylParam

Returns: SalBoolean.

RemoveAllImages()

Removes all images from control.

Returns: SalBoolean.

RemoveImage(nIndex)

Removes an image from control's internal ImageLists.

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.

SendMessage(nMsg, nMywParam, nMylParam)

Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.

Parameter
Type
Description

nMywParam

nMylParam

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

nMywParam

nMylParam

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.

SetContextMenu(sMenuName, nFlags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter
Type
Description

sMenuName

nFlags

Returns: SalBoolean.

SetContextMenu(menuType, nFlags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter
Type
Description

menuType

nFlags

Returns: SalBoolean.

SetCursor(nResourceId, nType)

Sets a window's cursor.

Parameter
Type
Description

nResourceId

Returns: SalBoolean.

SetCursor(sBlob, nType)

Sets a window's cursor from a string variable.

Parameter
Type
Description

Returns: SalBoolean.

SetCursorFile(sFile, nType)

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

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFocusItem(nItem)

Assigns focus to the specified item.

Parameter
Type
Description

Returns: SalBoolean.

SetFont(sName, nSize, nEnhancement)

Sets a window's font, font size, and font enhancements.

Parameter
Type
Description

nEnhancement

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.

Parameter
Type
Description

nSubItem

sItemText

Returns: SalBoolean.

SetItemValue(nItem, nItemValue)

Assigns an item's user data.

Parameter
Type
Description

nItemValue

Returns: SalBoolean.

SetLocation(nX, nY)

Moves a window to a new position (x, y) on the X and Y axes.

Parameter
Type
Description

Returns: SalBoolean.

SetProperty(sName, sValue, nLength)

Sets the value of a named property.

Parameter
Type
Description

sValue

nLength

Returns: SalBoolean.

SetSize(nWidth, nHeight)

Resizes a window.

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.

SetText(sText)

Sets the text of a window.

Parameter
Type
Description

Returns: SalBoolean.

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.

SetTimer(nIDEvent, nElapseMilliSec)

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

nIDEvent

nElapseMilliSec

Returns: SalBoolean.

SetWindowColor(nColorIndex, nColor)

Sets a window's color.

Parameter
Type
Description

nColorIndex

nColor

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

SortItems()

Sorts the items.

Returns: SalBoolean.

TrackPopupMenu(sMenuName, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

TrackPopupMenu(menuType, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Parameter
Type
Description

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.

ViewSmallIcons()

Tells control to display 'small icons' view.

Returns: SalNumber.

Events

WindowActions

WindowActionsEventHandler

Implements

Name
Description

Last updated