MulticolumnListbox class
| VI Server Class Information | |
|---|---|
| Return to VI Server Class Hierarchy | |
| Class Name | MulticolumnListbox class |
| Class ID | 46 |
| 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 MulticolumnListbox class is a class in the VI Server Class Hierarchy, (see also VI Server).
Contents |
Properties
Show/Hide MulticolumnListbox 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 |
|---|---|---|---|---|
| 18D99000 | Item Names | The strings for the selectable items in a two-dimensional array for rows and columns. | Read/Write | Yes |
| 18D99001 | Item Symbols | Array of item symbols. Item symbols (0-40) are as shown in the listbox symbol ring constant. | Read/Write | Yes |
| 18D99002 | Disabled Items | Array of indexes of disabled rows (first row is 0). | Read/Write | Yes |
| 18D99005 | Column Header Strings[] | An array of the strings in the column headers. | Read/Write | Yes |
| 18D99006 | Visible Items:Symbols Visible | If TRUE, displays the item symbols. | Read/Write | Yes |
| 18D99007 | Visible Items:Vertical Scrollbar Visible | If TRUE, displays the vertical scroll bar. | Read/Write | Yes |
| 18D99008 | Visible Items:Horizontal Scrollbar Visible | If TRUE, displays the horizontal scroll bar. | Read/Write | Yes |
| 18D99009 | Number of Rows | Number of visible rows in the multicolumn listbox, excluding column headers. This property counts partially visible rows. | Read/Write | Yes |
| 18D9900A | Number of Columns | Number of visible columns in the multicolumn listbox. This property counts partially visible columns. | Read/Write | Yes |
| 18D9900B | Visible Items:Column Headers Visible | If TRUE, displays the column headers. | Read/Write | Yes |
| 18D9900C | Top Left Visible Cell | The row and column of the item string displayed in the top left corner of the listbox. Use this property to read or change the top item, or use it to read or change the leftmost column of information displayed. | Read/Write | Yes |
| 18D9900D | 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 |
| 18D9900E | Active Cell:Active Cell | Sets the row and column of the active cell(s). | Read/Write | Yes |
| 18D9900F | Active Cell:Cell Foreground Color | Read/Write | Yes | |
| 18D99010 | Active Cell:Cell Background Color | The background color of the active cell(s). | Read/Write | Yes |
| 18D99011 | Active Cell:Cell Size | The size of the active cell(s) in pixels. | Read/Write | Yes |
| 18D99012 | Active Cell:Cell Size:Width | The width of the active cell(s) in pixels. | Read/Write | Yes |
| 18D99013 | Active Cell:Cell Size:Height | The height of the active cell(s) in pixels. | Read/Write | Yes |
| 18D99014 | Selection Color | The color used to highlight the selected items. | Read/Write | Yes |
| 18D99015 | 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 |
| 18D99016 | Smooth Horizontal Scrolling | If TRUE, the horizontal scrolling of the listbox is by pixels, such that the first column may be horizontally clipped. If FALSE, the listbox scrolls by whole column widths such that the first column is never clipped. However, if a column is wider than the width of the listbox, you cannot see the text that is hidden off the right edge of that column. | Read/Write | Yes |
| 18D99017 | 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 |
| 18D99018 | Selected Cell | Reads or writes the row and column of the most recently selected cell in the multicolumn listbox. | Read/Write | Yes |
| 18D99019 | Size | The width and height in pixels of the multicolumn listbox control. | Read/Write | Yes |
| 18D9901A | Size:Width | The width of the active cell(s) in pixels. | Read/Write | Yes |
| 18D9901B | Size:Height | The height of the active cell(s) in pixels. | Read/Write | Yes |
| 18D9901C | 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 multicolumn listbox control. | Read Only | Yes |
| 18D9901D | 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 multicolumn listbox control. | Read Only | Yes |
| 18D9901E | 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 multicolumn listbox control. | Read Only | Yes |
| 18D9901F | Content Rect Bounds | The size in pixels of the content rectangle of the multicolumn listbox control. | Read Only | Yes |
| 18D99020 | Content Rect Bounds:Width | The width in pixels of the content rectangle of the multicolumn listbox control. | Read Only | Yes |
| 18D99021 | Content Rect Bounds:Height | The height in pixels of the content rectangle of the multicolumn listbox control. | Read Only | Yes |
| 18D99022 | Active Cell:Position | The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active cell(s). | Read Only | Yes |
| 18D99023 | Active Cell:Position:Left | The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell. | Read Only | Yes |
| 18D99024 | Active Cell:Position:Top | The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell. | Read Only | Yes |
| 18D99025 | Active Cell:Cell Font | The font of the active cell in the multicolumn listbox control. | Read/Write | Yes |
| 18D99026 | Active Cell: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 |
| 18D99027 | Active Cell:Cell Font:Size | The size of the font in the active cell. | Read/Write | Yes |
| 18D99028 | Active Cell:Cell Font:Bold | Indicates whether the text in the active cell is bold. | Read/Write | Yes |
| 18D99029 | Active Cell:Cell Font:Italic | Indicates whether the text in the active cell is italic. | Read/Write | Yes |
| 18D9902A | Active Cell:Cell Font:Underline | Indicates whether the text in the active cell is underlined. | Read/Write | Yes |
| 18D9902B | Active Cell:Cell Font:Strikeout | Indicates whether to strike out the text in the active cell. | Read/Write | Yes |
| 18D9902C | Active Cell:Cell Font:Color | The text font color in the active cell. | Read/Write | Yes |
| 18D9902D | Active Cell:Cell Justification | Gets and sets the justification of text within a table cell. | Read/Write | Yes |
| 18D9902E | Drag/Drop:Allow Dragging (Deprecated) | Read/Write | Yes | |
| 18D9902F | Allow Editing Cells | If TRUE, users can edit non-header cells in the multicolumn listbox at run time by clicking the cell text in a selected listbox item. If FALSE, users cannot edit non-header cells. | Read/Write | Yes |
| 18D99030 | Old Edit Position | Read/Write | Yes | |
| 18D99031 | Visible Items:Row Headers Visible | Shows the row headers. | Read/Write | Yes |
| 18D99032 | Row Header Strings[] | An array of the strings in the row headers. | Read/Write | Yes |
| 18D99033 | Is Array? | Returns TRUE if the listbox has an array data type. | Read/Write | Yes |
| 18D99034 | Keyboard Mode | Sets how to handle upper and lowercase characters when you type characters in a multicolumn listbox at run time. Valid values include 0 (System Default), 1 (Case Sensitive), and 2 (Case Insensitive). | Read/Write | Yes |
| 18D99035 | Visible Items:Vertical Lines Visible | If TRUE, displays vertical lines that separate columns in the multicolumn listbox. | Read/Write | Yes |
| 18D99036 | Visible Items:Horizontal Lines Visible | If TRUE, displays horizontal lines that separate rows in the multicolumn listbox. | Read/Write | Yes |
| 18D99037 | 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 |
| 18D99038 | 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 of the array of strings from the row that you drag data, and a numeric indicating the glyph associated with the row from which you drag. 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 |
| 18D99039 | 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 |
| 18D9903A | 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 |
| 18D9903B | Select Entire Rows | Highlights the entire row if you select a row in the tree. | Read/Write | Yes |
| 18D9903C | Edit Position | The row-column pair index of the current text entry. Values of (0,0) indicate the top-left text entry. A value of -1 indicates the row or column header. Values of (-2, -2) indicate that no edits are being made to the text of the control. | Read/Write | Yes |
| 18D9903D | Focus Row | The focus row, used as the basis for key navigation such as the up and down arrows. | Read/Write | Yes |
| 18D9903E | Bulk Cells:Background Colors | Writes the background colors for a group of cells in the multicolumn listbox. | Write Only | Yes |
| 18D9903F | Bulk Cells:Font Colors | Writes the font colors for a group of cells in the multicolumn listbox. | Write Only | Yes |
Methods
Show/Hide MulticolumnListbox Methods Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Property ID | Long Name (English) | Description | RTE |
|---|---|---|---|
| 18D99400 | 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 |
| 18D99401 | Get Clicked Column Header | Get the column number for which the user clicked the column header. The first column on the left is numbered zero. A value of -2 means that no column header has been clicked. After this function reads the value, it changes the value back to -2. | Yes |
| 18D99402 | Point to Row Column | Converts a pixel coordinate to a row-column pair 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 |
| 18D99403 | 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 |
| 18D99404 | 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 |
| 18D99405 | Custom Item Symbols:Set To Custom Symbol | Sets the image of an item symbol. | Yes |
| 18D99406 | Custom Item Symbols:Set To Custom Symbol Array | Sets the images of all item symbols. | Yes |
| 18D99407 | Custom Item Symbols:Revert To Built In Symbol | Resets an item symbol to the default symbol for its index. | Yes |
| 18D99408 | Custom Item Symbols:Revert All To Built In Symbols | Resets all item symbols to the default symbols. | Yes |
Events
Show/Hide MulticolumnListbox Events Table
| Legend | |
|---|---|
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated |
| Code | Name | Description | Type |
|---|---|---|---|
| 1073741837 | Double Click | Generated when a user double-clicks a cell in a multicolumn listbox. LabVIEW does not generate this event if the user double-clicks the scrollbars or the border of the 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
| Version | Change(s) |
|---|---|
|
In LabVIEW 2020 the following changes were made:
|