ListBox class
| VI Server Class Information | |
|---|---|
| Return to VI Server Class Hierarchy | |
| Class Name | ListBox class |
| Class ID | 12 |
| Scope | Basic Development Environment |
| Class Inheritance |
|
| Class Children | This class has no children.
|
 |
This article is a stub. You can help LabVIEW Wiki by expanding it. Please improve this article if you can. |
The ListBox class is a class in the VI Server Class Hierarchy, (see also VI Server).
Contents |
Properties
Show/Hide ListBox Properties Table
| Legend | |
|---|---|
| R/W | Readable/Writable Permissions |
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Property ID | Long Name (English) | Description | R/W | RTE |
|---|---|---|---|---|
| 6337401 | Number of Rows | Number of visible items in the listbox. This property counts partially visible rows. | Read/Write | Yes |
| 6337402 | Pixel Width | Read/Write | Yes | |
| 6337403 | Selection Mode | Number of items the user can select. Valid values include 0 (zero or one), 1 (one), 2 (zero or more), and 3 (one or more). | Read/Write | Yes |
| 6337404 | Keyboard Mode | Sets how to handle upper and lowercase characters when you type characters in a listbox at run time. Valid values include 0 (System Default), 1 (Case Sensitive), and 2 (Case Insensitive). | Read/Write | Yes |
| 6337405 | Visible Items:Vertical Scrollbar Visible | If TRUE, displays the vertical scroll bar. | Read/Write | Yes |
| 6337406 | Visible Items:Symbols Visible | If TRUE, displays the item symbols. | Read/Write | Yes |
| 6337407 | Top Row | Row number currently at the top of the listbox. The number of visible items in the listbox does not limit the row number you can select for this property. | Read/Write | Yes |
| 6337408 | Double-Click | Read Only | Yes | |
| 6337409 | Item Names | Array of the strings for the selectable items. | Read/Write | Yes |
| 633740A | Item Symbols | Array of item symbols. Item symbols (0-40) are as shown in the listbox symbol ring constant. | Read/Write | Yes |
| 633740B | Disabled Items | Array of indexes of disabled items (first item is 0). | Read/Write | Yes |
| 633740D | Size | The width and height in pixels of the listbox control. | Read/Write | Yes |
| 633740E | Size:Width | The width of the listbox control in pixels. | Read/Write | Yes |
| 633740F | Size:Height | The height of the listbox control in pixels. | Read/Write | Yes |
| 6337410 | Content Rect Position | The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the content rectangle of the listbox control. | Read Only | Yes |
| 6337411 | Content Rect Position:Left | The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the listbox control. | Read Only | Yes |
| 6337412 | Content Rect Position:Top | The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the listbox control. | Read Only | Yes |
| 6337413 | Content Rect Bounds | The size in pixels of the content rectangle of the listbox control. | Read Only | Yes |
| 6337414 | Content Rect Bounds:Width | The width in pixels of the content rectangle of the listbox control. | Read Only | Yes |
| 6337415 | Content Rect Bounds:Height | The height in pixels of the content rectangle of the listbox control. | Read Only | Yes |
| 6337416 | Active Row:Cell Font | The font of the active cell in the listbox control. | Read/Write | Yes |
| 6337417 | Active Row:Cell Font:Name | The name of the font in the active cell. Predefined font names include App Font, Sys Font, and Dlg Font. | Read/Write | Yes |
| 6337418 | Active Row:Cell Font:Size | The size of the font in the active cell. | Read/Write | Yes |
| 6337419 | Active Row:Cell Font:Bold | Indicates whether the text in the active cell is bold. | Read/Write | Yes |
| 633741A | Active Row:Cell Font:Italic | Indicates whether the text in the active cell is italic. | Read/Write | Yes |
| 633741B | Active Row:Cell Font:Underline | Indicates whether the text in the active cell is underlined. | Read/Write | Yes |
| 633741C | Active Row:Cell Font:Strikeout | Indicates whether to strike out the text in the active cell. | Read/Write | Yes |
| 633741D | Active Row:Cell Font:Color | The text font color in the active cell. | Read/Write | Yes |
| 633741E | Active Row:Cell Justification (Deprecated) | Read/Write | Yes | |
| 633741F | Allow Dragging (Deprecated) | Read/Write | Yes | |
| 6337420 | Allow Editing Cells | If TRUE, users can edit non-header cells in the listbox at run time by clicking the cell text and then clicking the text a second time after a short pause. If FALSE, users cannot edit non-header cells. | Read/Write | Yes |
| 6337421 | Old Edit Row | Read/Write | Yes | |
| 6337423 | Visible Items:Column Header Visible | If TRUE, displays the column header. | Read/Write | Yes |
| 6337424 | Column Header String | The string in the column header. | Read/Write | Yes |
| 6337425 | Is Array? | Returns TRUE if the listbox has an array data type. | Read/Write | Yes |
| 6337426 | Selection Color | Color used to draw the data selection. | Read/Write | Yes |
| 6337427 | Multiple Line Input | If TRUE, you can enter multiple lines of text in the listbox cells by pressing the <Enter> key on the keyboard. If FALSE, pressing the <Enter> key on the keyboard while editing cells causes LabVIEW to commit the edits in the current cell and move the text focus to the next cell. This property does not affect run-time behavior of the listbox. | Read/Write | Yes |
| 6337428 | Autosizing Row Height | Determines whether the rows autosize their height to display all text when fonts change or when the number of lines in a cell changes. | Read/Write | Yes |
| 6337429 | Active Row:Active Row Number | Sets the active row. A value of –1 indicates the column header. A value of –2 indicates all rows. | Read/Write | Yes |
| 633742A | Active Row:Cell Height | The height of the active cell(s) in pixels. | Read/Write | Yes |
| 633742B | Active Row:Active Row Position | The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active row(s). | Read Only | Yes |
| 633742C | Active Row:Active Row Position:Left | The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active row. | Read Only | Yes |
| 633742D | Active Row:Active Row Position:Top | The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active row. | Read Only | Yes |
| 633742E | Active Row:Cell Background Color | The background color of the active cell(s). | Read/Write | Yes |
| 633742F | Visible Items:Horizontal Lines Visible | If TRUE, displays horizontal lines that separate rows in the listbox. | Read/Write | Yes |
| 6337430 | Drag/Drop:Allow Dragging | If TRUE, LabVIEW automatically begins a drag and drop operation from the control when you use the Operating tool to select and drag an item from the control. | Read/Write | Yes |
| 6337431 | Drag/Drop:Allow Dropping | If TRUE, LabVIEW automatically accepts drops containing the LV_LISTBOX, LV_TEXT, or LV_LISTBOX_ITEMS data types. The LV_LISTBOX data type is a cluster that contains an array of strings from the row that you are dragging data, and a numeric indicating the glyph associated with the row from which you are dragging. The LV_TEXT data type is of type string. The LV_LISTBOX_ITEMS data type is an array of a cluster containing an array of strings, from left to right, in the item you are dragging and an integer representing the glyph index associated with the item from which you are dragging data. | Read/Write | Yes |
| 6337432 | Drag/Drop:Drag Mode | Sets the default behavior for a drag and drop operation for the control. The settings apply only when the control configured is the source of the drag and drop operation. | Read/Write | Yes |
| 6337433 | Drag/Drop:Allow Drag and Drop Outside Control | If TRUE, this enables the control to drag items to other controls and accept drags from other controls. | Read/Write | Yes |
| 6337434 | Select Entire Rows | Highlights the entire row if you select a row in the tree. | Read/Write | Yes |
| 6337435 | Edit Row | The row of the current text entry. A value of 0 indicates the top row. A value of –1 indicates the column header. A value of –2 indicates that no edits are being made to the text of the control. | Read/Write | Yes |
| 6337436 | Active Row:Cell Justification | Gets or sets the justification of text within the active row of the listbox. | Read/Write | Yes |
| 6337437 | Focus Row | Read/Write | Yes |
Methods
Show/Hide ListBox Properties Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Method ID | Long Name (English) | Description | RTE |
|---|---|---|---|
| 6337000 | Point to Row | Converts a pixel coordinate to a row in the coordinates of the control. This method also returns whether the point is inside the bounds of the content rectangle and whether the point is within the custom symbol of the cell. | Yes (Read/Write) |
| 6337001 | Get Double-Clicked Row | Gets the row number the user double-clicked. The first row on the top is numbered zero. A value of –2 means that no row has been double-clicked. After this method reads the value, it changes the value back to –2. This method does not respond to a double-click on the header. | Yes (Read/Write) |
| 6337002 | Custom Item Symbols:Get Symbol | Returns the item symbol as a cluster of image data so you can draw it as a picture using the Draw Flattened Pixmap VI or save the image to a file using the Graphics Formats VIs. | Yes (Read/Write) |
| 6337003 | Custom Item Symbols:Get Symbol Array | Returns the item symbols as an array of clusters of image data so you can draw them as pictures using the Draw Flattened Pixmap VI or save the images to files using the Graphics Formats VIs. | Yes (Read/Write) |
| 6337004 | Custom Item Symbols:Set To Custom Symbol | Sets the image of an item symbol. | Yes (Read/Write) |
| 6337005 | Custom Item Symbols:Set To Custom Symbol Array | Sets the images of all item symbols. | Yes (Read/Write) |
| 6337006 | Custom Item Symbols:Revert To Built In Symbol | Resets an item symbol to the default symbol for its index. | Yes (Read/Write) |
| 6337007 | Custom Item Symbols:Revert All To Built In Symbols | Resets all item symbols to the default symbols. | Yes (Read/Write) |
Events
Show/Hide ListBox Events Table
| Legend | |
|---|---|
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated |
| Code | Name | Description | Type |
|---|---|---|---|
| 1073741837 | Double Click | Generated when a user double-clicks an item in a listbox. | Notify |
| 1073741880 | Edit Cell | Generated when the user enters new text or changes text in a cell. | Notify |
| 2147483703 | Edit Cell? | Generated when the user enters new text or changes text in a cell but before the new or changed text appears. | Filter |
History
 |
History information is needed. What changes have occurred over previous versions? |
| Version | Change(s) |
|---|---|
|
More info to come. |