DataListView Class |  |
Create a data list view as a faster, read-only, standalone control and an alternative to a data browser.
Inheritance HierarchyNamespace: VO
Assembly: VOGUIClasses (in VOGUIClasses.dll) Version: 2.19
SyntaxThe DataListView type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataListView |
Construct a data list view.
|
Properties| Name | Description | |
|---|---|---|
 | Background |
The brush used for painting the background of the control. For example, in a single line edit control, the background is the color behind the text in the edit control.
(Inherited from Control.) |
| BackgroundColor |
A Color object used to paint the background in the list view.
(Inherited from ListView.) |
| Caption |
The string representing the caption of the text control.
(Inherited from TextControl.) |
| CheckBoxes |
A logical value determining whether check boxes are used in the list view.
(Inherited from ListView.) |
| ColumnCount |
A numeric value representing the number of columns in the list view.
(Inherited from ListView.) |
| ColumnOrderArray |
An array of ListViewColumn object symbolic names representing the order of the columns in the list view.
(Inherited from ListView.) |
| ContextMenu |
A menu object representing the local pop-up menu for a control.
(Inherited from Control.) |
| ControlFont |
The font used to draw the text in the control.
(Inherited from TextControl.) |
| ControlID |
A number between 1 and 8000 representing the unique ID of a control
(Inherited from Control.) |
| CurrentText |
A string representing the text currently displayed in a text control. For edit controls, including the edit box associated with simple and drop-down combo boxes, it contains the text currently appearing in the edit box. For fixed icon and group box controls, TextControl:CurrentText contains NULL_STRING.
(Inherited from TextControl.) |
| CurrentView |
A symbolic name representing the current view of the list view.
(Inherited from ListView.) |
| DragDropEnabled |
A logical value that is TRUE if drag and drop is enabled for the list view. If drag and drop is enabled, items can be dragged within, as well as outside, the control.
(Inherited from ListView.) |
| DragImageList |
An image list containing a single image displayed during a drag and drop operation for the list view.
(Inherited from ListView.) |
| FieldSpec |
The field specification connected to the control.
(Inherited from Control.) |
| FullRowSelect |
A logical value determining whether the entire row is highlighted when a list view item is selected.
(Inherited from ListView.) |
| GridLines |
A logical value determining whether gridlines are shown in the list view.
(Inherited from ListView.) |
| HeaderDragDrop |
A logical value determining whether columns can be rearranged in the list view by dragging and dropping the column headers.
(Inherited from ListView.) |
| HyperLabel |
The hyperlabel connected to the control.
(Inherited from Control.) |
| IsGroupViewEnabled |
A logical value to identify if ListView groups are enabled.
(Inherited from ListView.) |
| ItemCount |
A numeric value representing the number of items in the list view.
(Inherited from ListView.) |
| ItemsPerPage |
A numeric value representing the number of items that can fit vertically in the visible area of the list view.
(Inherited from ListView.) |
 | LargeImageList |
An image list containing large images to display for each item when the list view is displayed in icon view.
(Inherited from ListView.) |
| Length |
A numeric value representing the number of characters in the control.
(Inherited from TextControl.) |
| Modified |
A logical value that is set to TRUE when a standard edit control or editable combo box is in the process of being modified.
(Inherited from Control.) |
| Name |
A string representing the name of the control.
(Inherited from Control.) |
| NameSym |
A symbol representing the name of the control.
(Inherited from Control.) |
| Origin |
A point representing the location of a control on its owner window, in canvas coordinates.
(Inherited from Control.) |
| Owner |
The owner of this DataListView control.
(Overrides Owner.) |
| OwnerAlignment |
Constant representing how the window will be aligned within its owner window.
(Inherited from Control.) |
| ReadOnly |
Is the control readonly ?
(Inherited from Control.) |
| SearchString |
The incremental search string associated with the list view.
(Inherited from ListView.) |
| SelectedCount |
A numeric value representing the number of items that are selected in the list view.
(Inherited from ListView.) |
| Server |
The data server associated with the data list view.
(Overrides Server.) |
| Size |
A dimension representing the size of a control.
(Inherited from Control.) |
| SmallImageList |
An image list containing small images to display for each item when the list view is displayed in list view, report view, or small icon view. The icons in this list must be defined elsewhere in
(Inherited from ListView.) |
| StateImageList |
An image list containing state images to display for each item in the list view.
(Inherited from ListView.) |
| Status |
A hyperlabel indicating the status of the control after a validation attempt or other action.
(Inherited from Control.) |
| TextBackgroundColor |
A Color object used to paint the text background in the list view.
(Inherited from ListView.) |
| TextColor |
A Color object used to paint the text in the list view.
(Inherited from ListView.) |
| TextValue |
A string representing the value held in the control.
(Inherited from TextControl.) |
| ToolTipText |
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.) |
| TopItem |
A numeric value representing the index of the topmost visible item when the list view is in list view or report view.
(Inherited from ListView.) |
| UseHLForToolTip |
Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text.
(Inherited from Control.) |
| Value |
The value held in the control, in whatever data type the control holds.
(Inherited from Control.) |
| ValueChanged |
A logical value representing whether the control's Value has been changed from its prior setting.
(Inherited from Control.) |
| ViewBoundingBox |
The bounding box that encloses all of a list view's items when in icon view or small icon view.
(Inherited from ListView.) |
| ViewOrigin |
The Point object representing the current view origin of a list view when in icon view or small icon view.
(Inherited from ListView.) |
Methods| Name | Description | |
|---|---|---|
| Activate |
Provide a method that is invoked when the control has focus and a window is activated. (Inherited from Control.) |
| AddColumn |
Add a new ListViewColumn object to the end of the list view's list of columns.
(Inherited from ListView.) |
| AddGroup |
Set an image as the background to the list view.
(Inherited from ListView.) |
| AddItem |
Add a new ListViewItem object as the last item in the list view.
(Inherited from ListView.) |
| Arrange |
Align list view items while in icon view.
(Inherited from ListView.) |
| AsString |
Return the contents of the control (or its identifying label).
(Inherited from Control.) |
| Create |
Creates the underlying Win32 control
(Inherited from TextControl.) |
| Deactivate |
Provide a method that is invoked when the control has focus and a window is deactivated. (Inherited from Control.) |
| DEFAULT | Call the default windows procedure for a control and set the EventReturnValue. (Inherited from Control.) |
| DeleteAll |
Delete all items in a data list view.
(Overrides DeleteAll.) |
| DeleteAllColumns |
Delete all columns from a list view.
(Inherited from ListView.) |
| DeleteColumn |
Delete a ListViewColumn object from the list view.
(Inherited from ListView.) |
| DeleteItem |
Delete a ListViewItem object from the list view.
(Inherited from ListView.) |
| Destroy |
Provide a method to de-instantiate a DataListView object.
(Overrides Destroy.) |
| Disable |
Disable a control (until a subsequent call to Control:Enable()).
(Inherited from Control.) |
| DisableTheme |
Disable the WinXP theme for a control.
(Inherited from Control.) |
| Dispatch |
Provide the prototype dispatcher for events within the system when the control has focus; routing various events to their appropriate event handlers. (Inherited from Control.) |
| EditItemLabel |
Begins in-place label editing of an item in the list view.
(Inherited from ListView.) |
| Enable |
Enable a control that was previously disabled.
(Inherited from Control.) |
| EnableDragDrop |
Enable or disable drag and drop of items for the list view.
(Inherited from ListView.) |
| EnableGroupView |
Set Group View on or off in a ListView control.
(Inherited from ListView.) |
| EnableSort |
Register a user-defined method to use for sorting items in the list view.
(Inherited from ListView.) |
| EnsureVisible |
Ensure that an item is visible in the list view, scrolling if necessary.
(Inherited from ListView.) |
| Expose |
Provide a method that is invoked when the control has focus and whenever part of the window needs repainting. (Inherited from Control.) |
| FIELDGET | |
| FocusChange |
Provide a method that is invoked when the control has focus and the input focus changes from the current control to another (or vice versa). (Inherited from Control.) |
| Font |
Change the current font of the text control.
(Inherited from TextControl.) |
| GetAllItems |
Get an array with all the Listview Items
(Inherited from ListView.) |
| GetAllSelectedItems |
Get an array with all the selected Listview Items
(Inherited from ListView.) |
| GetColumn |
Return a particular ListViewColumn object.
(Inherited from ListView.) |
| GetExStyle |
Retrieve the Ex styles for the control.
(Inherited from Control.) |
| GetGroupTextColor |
Get the text color used for the headings when displaying a ListView control by group.
(Inherited from ListView.) |
| GetItemAtPosition |
Return a ListViewItem object at a particular position, if one exists.
(Inherited from ListView.) |
| GetItemAttributes |
Return a ListViewItem object given its item index.
(Inherited from ListView.) |
| GetItemBoundingBox |
Return the bounding box of a ListViewItem object given its item index.
(Inherited from ListView.) |
| GetItemPosition |
Return the origin of a ListViewItem object given its item index.
(Inherited from ListView.) |
| GetItemSpacing |
Return the spacing between list view items in icon view or small icon view.
(Inherited from ListView.) |
| GetNextItem |
Retrieve the next list view item that possesses all of the specified properties.
(Inherited from ListView.) |
| GetSelectedItem |
Retrieve the currently selected ListViewItem object.
(Inherited from ListView.) |
| GetStyle |
Retrieve the styles for the control.
(Inherited from Control.) |
| Handle |
Return the handle for a control.
(Inherited from Control.) |
| HasBorder | Check if a border has been set for the control (Inherited from Control.) |
| HasGroup |
A logical value to determine if the group with the specified ID exists in a ListView control.
(Inherited from ListView.) |
| HasStyle | Check if a style value has been set for the control (Inherited from Control.) |
| Hide |
Hide a control so it is not visible (until a subsequent call to Control:Show()).
(Inherited from Control.) |
| HorizontalScroll |
Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled. (Inherited from Control.) |
| Ime |
Return and optionally set whether Input Method Editor is enabled for this text control.
(Inherited from TextControl.) |
| InsertColumn |
Insert a new ListViewColumn object after a particular column index in the list view.
(Inherited from ListView.) |
| InsertItem |
Insert a new ListViewItem object after a particular item index in the list view.
(Inherited from ListView.) |
| IsEnabled |
Report if this control is currently enabled.
(Inherited from Control.) |
| IsExStyle | Check if a exstyle value has been set for the control (Inherited from Control.) |
| IsReadOnly |
Report if this control is currently readonly.
(Inherited from Control.) |
| IsStyle | Check if a style value has been set for the control (Inherited from Control.) |
| IsVisible |
Report if this control is visible (completely or partially) or hidden.
(Inherited from Control.) |
| KeyDown |
Provide a method that is invoked when the control has focus and a key on the keyboard is pressed. (Inherited from Control.) |
| KeyUp |
Provide a method that is invoked when the control has focus and a key on the keyboard is released. (Inherited from Control.) |
| LinkDF |
Connect a control to a data field in a data server.
(Inherited from Control.) |
| MenuInit |
Provide a method that is invoked when a pop-up menu owned by the control is about to pop up.
(Inherited from Control.) |
| MenuSelect |
Provide a method that is invoked when an item on a menu owned by the control is highlighted.
(Inherited from Control.) |
| MouseButtonDoubleClick |
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is double-clicked. (Inherited from Control.) |
| MouseButtonDown |
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is clicked. (Inherited from Control.) |
| MouseButtonUp |
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is released.
(Inherited from Control.) |
| MouseDrag |
Provide a method that is invoked when the control has focus and a mouse with one or more buttons clicked is moved in the window.
(Inherited from Control.) |
| MouseMove |
Provide a method that is invoked when the control has focus and the mouse is moved in the control.
(Inherited from Control.) |
| Move |
Provide a method that is invoked when the control has focus and the control is moved (either by the user or by the application).
(Inherited from Control.) |
| Notify |
Provide an event handler that reflects events that have occurred in the server connected to this data list view.
|
| OverRide | This is a compatibility method that is no longer used or needed. (Inherited from Control.) |
| PerformValidations |
Perform all the validations defined to this control's field specification (for example, required, maximum and minimum digits, maximum and minimum value, validation rule) and return the result of the test.
(Inherited from Control.) |
| RedrawRange |
Redraw a range of list view items.
(Inherited from ListView.) |
| Refresh |
Force the contents of the data list view to be updated from the data server.
|
| RegisterTimer |
Register a timer method to be invoked for the control.
(Inherited from Control.) |
| RemoveAllGroups |
Remove all groups from a ListView control.
(Inherited from ListView.) |
| RemoveEditBalloonTip |
Removes the current BallonTip from the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| RemoveGroup |
Remove the group with the specified ID from a ListView control.
(Inherited from ListView.) |
| RePaint |
Send an ExposeEvent to repaint the control
(Inherited from Control.) |
| Resize |
Provide a method that is invoked when the control has focus and the control changes size.
(Inherited from Control.) |
| RestoreUpdate |
Resume all drawing updates for a control (after Control:SuspendUpdate() is called).
(Inherited from Control.) |
| Scroll |
Scroll the contents of a list view.
(Inherited from ListView.) |
| Seek |
Search the list view for a particular list view item.
(Inherited from ListView.) |
| SelectItem |
Select or deselect a specific item in a list view.
(Inherited from ListView.) |
| SelectNextItem |
Select the next list view item after the currently selected item.
(Inherited from ListView.) |
| SetBackgroundImage |
Set an image as the background to the list view.
(Inherited from ListView.) |
| SetColumnFormat |
Set the desired extended style for a list view.
(Inherited from ListView.) |
| SetCueBanner |
Add a cue banner to the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| SetExStyle |
Set the exstyle for the control.
(Inherited from Control.) |
| SetFocus |
Pass input focus to a control, thereby directing all mouse and keyboard input to the control.
(Inherited from Control.) |
| SetGroupName |
Set the name of a list view group.
(Inherited from ListView.) |
| SetGroupTextColor |
Set the text color to be used for the headings when displaying a ListView control by group.
(Inherited from ListView.) |
| SetItemAttributes |
Update a ListViewItem object with new attributes.
(Inherited from ListView.) |
| SetItemGroupId |
A logical value to determine if the group with the specified ID exists in a ListView control.
(Inherited from ListView.) |
| SetItemPosition |
Move a list view item to a new position in icon view or small icon view.
(Inherited from ListView.) |
| SetParent |
Change the parent handle for the control.
(Inherited from Control.) |
| SetSelectedColumn |
Show column as selected.
(Inherited from ListView.) |
| SetStyle |
Set the style for the control.
(Inherited from Control.) |
| Show |
Display a control so it is visible.
(Inherited from Control.) |
| ShowEditBalloonTip |
Add a BallonTip to the Edit control that has inherited from this class.
(Inherited from TextControl.) |
| SortItems |
Sort the list view items using the user-defined sort method specified by EnableSort().
(Inherited from ListView.) |
| SuspendUpdate |
Temporarily suspend all drawing updates for a control; drawing resumes with a call to Control:RestoreUpdate().
(Inherited from Control.) |
| Timer |
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
(Inherited from Control.) |
| Update |
Update a list view item.
(Inherited from ListView.) |
| Use |
Associate a data server with the data list view.
|
| ValidateControl | This method validates if the control has been created and when not then it triggers the control creation (Inherited from Control.) |
| VerticalScroll |
Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled.
(Inherited from Control.) |
| ViewAs |
Change the current view of the list view.
(Inherited from ListView.) |
Fields| Name | Description | |
|---|---|---|
 | EventReturnValue | (Inherited from Control.) |
| oCargo | Cargo slot. (Inherited from VObject.) |
Remarks
A data list view is a "data-ware" list view control which serves as a fast, read-only alternative to a data browser. Together with the list view column control, a data list view can be used inside the Window Editor to "paint" the browse view portion of a data window. It can also be used as a standalone control.
The DataListView control uses internally a virtual list view, which means that its speed is independent of the total number of records in your database. Additionally, the scrollbar size and position always represents the position in the database correctly.
The DataListView control relies on the OrderKeyCount(), OrderKeyGoto(), and OrderKeyNo() methods of the associated server. If there is no active order, the DataListView control uses RecCount(), GoTo(), and RecNo() instead. Additionally, the DataListView control has some limitations, depending on the currently active RDD:
SetFilter is supported for NTX and CDX drivers only.
SetDeleted(TRUE) is not supported for all RDDs.
If you want to hide all deleted records, you should use SetDeleted(FALSE) and specify a data server filter condition like:
OrderScopes are supported for NTX and CDX drivers only.
If you want to use a DataListView control as a replacement for a DataBrowser control, set the Browser Inherits From property in the Window Editor to DataListView. The generated code will then reference DataListView.
The DataListView control can also be used as a standalone control that can be placed on any window or dialog. In this case, you have to explicitly assign a data server to the DataListView:Server property.
X#
1SetFilter({|| !Deleted()}, "!Deleted()")
 Tip |
|---|
| Choosing a DataListView control as a replacement for a DataBrowser control has an additional advantage: your applications will not need the CATO3xxx.DLL support DLLs. |
See Also