ListView Control

A ListView control displays a list of items with associated icons.

Client support

Newlook Smartclient only.

Use

A ListView control can be used to create a user interface like the right pane of Windows Explorer. It is useful if you want to present data to the user in some sort of tabular format.

The key property of the ListView control is List Items, which contains the items displayed by the control. The user can select multiple items, for example to drag and drop several items at a time to another control, if the MultiSelect property is set to true. The ListView control can display check boxes next to the items, if the CheckBoxes property is set to true.

Material skin considerations

When the material skin is enabled in your solution, list views will be rendered with material styling. The most noticeable difference is an increase in the spacing within the list. If you have checkboxes enabled, then they will be rendered with the material primary color in the selected state.

Material skin	Classic skin

Common ListView Tasks

Inserting a ListView control

Open the relevant screen in Designer () mode.
Select Insert | Other | ListView () from the main menu, then use your cursor to draw the graphic area on the screen.
Set any relevant properties in the Properties pane. For more information on list view properties refer to properties section of the ListView Control reference topic.

Adding and removing list items manually

In Designer, select the ListView control.
Add one or more columns (the number of columns that will show in your ListView control will depend on the View property value. To do this click on the ColumnHeaders property prompt button () to open the Column Collection Editor, or select the control, right-click and select Show Columns Editor.
Click on the ListItems property prompt button () to open the Item Collection Editor, or right-click and select Show Items Editor .

Click the Add button and type in the text of your first list item. Modify any properties of this list item.
Add a sub-item by locating your cursor in the cell to the right of the list item and set its Text property (you will need to have created more than one column and set the View property to ViewReport to view sub-items).

Adding and Removing list items dynamically

Additional list items can be added to a ListView control's ListItems collection via the Add method. To remove all items from a ListView use the Clear method, to remove individual items use the Remove method.

Setting the view mode of the list view

A list view control can display in four different modes as specified in the View property: ViewIcon, ViewSmallIcon, ViewList and ViewReport (default).


ViewIcon	ViewSmallIcon	ViewList	ViewReport

Properties

Newlook Smartclient | Newlook Server | Deprecated | Obsolete

Property	Client	Description
AllowColumnReorder		Returns or sets whether users can reorder columns in report view.
AllowDrop		Specified whether the control will allow files to be dropped onto it.
Arrange		Returns or sets how the icons are arranged. Obsolete
BackColor		Determines the background color.
BorderStyle		Returns or sets the border style for the control.
CCSID		Sets or returns the Coded Character sets Identifier.
CheckBoxes		Returns or sets whether a check box is displayed next to each list item.
ColumnHeaders		Collection of column headers.
DroppedFiles		A collection whose elements represent each file dropped onto the control.
Enabled		Determine if control can respond to events.
FontBold		Use bold text formatting.
FontItalic		Use italic text formatting.
FontName		Determines the font used to display text.
FontSize		Sets the size of the font to be used.
FontUnderline		Use underlined text formatting.
ForeColor		Determines the foreground color used to display text.
FormControlsCollectionIndex		Sets or returns the current control index for an object.
FullRowSelect		Gets or sets a value which determines if selecting a column will highlight the entire row. Deprecated property. Obsolete
GridLines		Returns or sets whether grid lines are displayed between rows and columns. Obsolete
Height		Sets or returns the height of an object, in pixels.
HideColumnHeaders		Returns or sets whether column headers are hidden in report view.
HideSelection		Gets or sets a value that determines whether the selected node or list view item remains selected when the control loses focus. Deprecated property. Obsolete
HotTracking		Returns or sets whether hot tracking is enabled.
Icons		Icon image list
LabelEdit		Returns or sets whether the user can edit item labels.
LabelWrap		Returns or sets whether labels are wrapped in icon view.
LastClickedColumn		Returns the last ColumnHeader clicked.
LastClickedItem		Returns the last ListItem clicked.
LastColumnClicked		Returns the index of the last ColumnHeader clicked. Deprecated
LastItemClicked		Returns the index of the last ListItem clicked. Deprecated
Left		Determine distance, in pixels, between left edge of the control and left edge of its form.
ListItems		Collection of list items.
MultiSelect		Returns or sets whether the control supports multiple selection.
Name		Name used to identify an object.
OnAfterLabelEdit		Gets or sets the macro or script to be run when the AfterLabelEdit event occurs.
OnBeforeLabelEdit		Gets or sets the macro or script to be run when the BeforeLabelEdit event occurs.
OnClick		Sets or returns the name of a macro to be run when the Click event occurs.
OnColumnClick		Sets or returns the name of the macro to be run when the ColumnClick event occurs.
OnDrop		Sets or returns the name of a macro or script to be run when the Drop event occurs.
OnGotFocus		Sets or returns the name of a macro to be run when the GotFocus event occurs.
OnItemCheck		Sets or returns the name of a macro to be run when the ItemCheck event occurs.
OnItemClick		Sets or returns the name of a macro to be run when the ItemClick event occurs.
OnItemDblClick		Sets or returns the name of a macro to be run when the ItemDblClick event occurs.
OnLostFocus		Sets or returns the name of a macro to be run when the LostFocus event occurs.
SmallIcons		Returns or sets the index of small icons to be used in the list and detail views.
Sorted		Specifies whether the items in the list portion of a control are automatically sorted alphabetically.
SortKey		Returns or sets the column to be used for sorting.
SortOrder		Returns or sets the sort order.
StateIcons		State icon image list. Obsolete
TabIndex		Returns the tab index of the control.
TabStop		Determine whether a control can receive focus.
Tag		Store additional information about an object.
Top		Determine distance, in pixels, between top edge of the control and the top edge of its form.
Type		Specifies an object's type.
Variable		Sets or returns the name of a variable that stays synchronized with contents of the control. Obsolete
View		Returns or sets the current view.
Visible		Determine if an object is visible or hidden.
Width		Sets or returns the width of an object, in pixels.

Methods