Jump to content

ListBox class: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
VisualWikitext
mNo edit summary
Replaced with template tables
Tag: Replaced
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide ListBox Properties Table</span>
{{VIServerClassTables|12}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ ListBox Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|6337429
| [[ListBox class/Active Row property|Active Row]]
|Sets the active row. A value of &#8211;1 indicates the column header. A value of &#8211;2 indicates all rows.
 
The active row is the row of a listbox to which you can apply property changes. The active row is not the same as the selected row and the active row does not change if you manually select a different row.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633742B
| [[ListBox class/ActiveRowPos property|ActiveRowPos]]
|The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active row(s).
|R
|X
|- style="background-color:#FFFFCC;"
|633742C
| [[ListBox class/ActiveRowPosLeft property|ActiveRowPosLeft]]
|The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active row.
 
This property is an element of the Active Row:Active Row Position property.
|R
|X
|- style="background-color:#FFFFCC;"
|633742D
| [[ListBox class/ActiveRowPosTop property|ActiveRowPosTop]]
|The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active row.
 
This property is an element of the Active Row:Active Row Position property.
|R
|X
|- style="background-color:#FFFFCC;"
|633742E
| [[ListBox class/CellBG property|CellBG]]
|The background color of the active cell(s).
 
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337416
| [[ListBox class/CellFont property|CellFont]]
|The font of the active cell in the listbox control.
 
Use this property to change the size, style, or color of the cell font. You cannot use this property with a strict type definition.
 
{| class="wikitable"
|+ scope="col" style="text-align:left;"|Elements:
! scope="col" style="text-align:left;"| Name
! scope="col" style="text-align:left;"| Description
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Size
|The size of the font in the active cell.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Bold
|Indicates whether the text in the active cell is bold.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Italic
|Indicates whether the text in the active cell is italic.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Underline
|Indicates whether the text in the active cell is underlined.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Strikeout
|Indicates whether to strike out the text in the active cell.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Color
|The text font color in the active cell.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337419
| [[ListBox class/CellFontBold property|CellFontBold]]
|Indicates whether the text in the active cell is bold.
 
This property is an element of the Active Row:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633741D
| [[ListBox class/CellFontColor property|CellFontColor]]
|The text font color in the active cell.
 
This property is an element of the Active Row:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633741A
| [[ListBox class/CellFontItalic property|CellFontItalic]]
|Indicates whether the text in the active cell is italic.
 
This property is an element of the Active Row:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337417
| [[ListBox class/CellFontName property|CellFontName]]
|The name of the font in the active cell. Predefined font names include App Font, Sys Font, and Dlg Font.
 
This property is an element of the Active Row:Cell Font property.
 
If you select an invalid font, this property returns an error.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337418
| [[ListBox class/CellFontSize property|CellFontSize]]
|The size of the font in the active cell.
 
This property is an element of the Active Row:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633741C
| [[ListBox class/CellFontStrike property|CellFontStrike]]
|Indicates whether to strike out the text in the active cell.
 
This property is an element of the Active Row:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633741B
| [[ListBox class/CellFontUnder property|CellFontUnder]]
|Indicates whether the text in the active cell is underlined.
 
This property is an element of the Active Row:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633742A
| [[ListBox class/Cell Height property|Cell Height]]
|The height of the active cell(s) in pixels.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337436
| [[ListBox class/CellJustify property|CellJustify]]
|Gets or sets the justification of text within the active row of the listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337420
| [[ListBox class/Allow Editing Cells property|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.
 
This property is similar to the Editable Cells item on the shortcut menu of a listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337428
| [[ListBox class/AutoRowHt property|AutoRowHt]]
|Determines whether the rows autosize their height to display all text when fonts change or when the number of lines in a cell changes.
 
If FALSE, you can have clipped text in cells, and the user will be unable to manually resize the row height at run time to see all of the text. This property affects only user input. If you use the Value property to set the listbox strings, the rows do not automatically resize. To resize the rows, set this property to FALSE and then set it back to TRUE.
 
This property is similar to the Autosize Row Height item on the shortcut menu of a single-column listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337424
| [[ListBox class/ColHdr property|ColHdr]]
|The string in the column header.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337413
| [[ListBox class/ContentRectBounds property|ContentRectBounds]]
|The size in pixels of the content rectangle of the listbox control.
|R
|X
|- style="background-color:#FFFFCC;"
|6337415
| [[ListBox class/ContentRectBoundsHeight property|ContentRectBoundsHeight]]
|The height in pixels of the content rectangle of the listbox control.
 
This property is an element of the Content Rect Bounds property.
|R
|X
|- style="background-color:#FFFFCC;"
|6337414
| [[ListBox class/ContentRectBoundsWidth property|ContentRectBoundsWidth]]
|The width in pixels of the content rectangle of the listbox control.
 
This property is an element of the Content Rect Bounds property.
|R
|X
|- style="background-color:#FFFFCC;"
|6337410
| [[ListBox class/ContentRectPos property|ContentRectPos]]
|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.
|R
|X
|- style="background-color:#FFFFCC;"
|6337411
| [[ListBox class/ContentRectPosLeft property|ContentRectPosLeft]]
|The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the listbox control.
 
This property is an element of the Content Rect Position property.
|R
|X
|- style="background-color:#FFFFCC;"
|6337412
| [[ListBox class/ContentRectPosTop property|ContentRectPosTop]]
|The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the listbox control.
 
This property is an element of the Content Rect Position property.
|R
|X
|- style="background-color:#FFFFCC;"
|633740B
| [[ListBox class/DisabledItems property|DisabledItems]]
|Array of indexes of disabled items (first item is 0).
 
If you set this property for an item that is not in the listbox, this property returns an error.
 
This property is similar to the Disable Item item on the shortcut menu of a listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337433
| [[ListBox class/AllowDragOutsideControl property|AllowDragOutsideControl]]
|If TRUE, this enables the control to drag items to other controls and accept drags from other controls.
 
Use the Control events for more control over how users drag items within controls.
 
You can use this property with the Drag/Drop:Allow Dragging and the Drag/Drop:Allow Dropping properties to allow data dragging to other controls and to accept data drops from other controls.
 
This property is similar to the Allow Drag Drop Outside Control item on the shortcut menu of a listbox control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337430
| [[ListBox class/Allow Dragging property|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.
 
Use the Control events for more control over how users drag items within controls. This property is similar to the Allow Dragging item on the shortcut menu of a listbox control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337431
| [[ListBox class/Allow Dropping property|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.
 
Use the Control events for more control over how users drag items within controls. This property is similar to the Allow Dropping item on the shortcut menu of a listbox control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337432
| [[ListBox class/Drag Mode property|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.
 
Use the Control events for more control over how users drag items within controls.
 
This property is similar to the Drag Mode item on the shortcut menu of a listbox control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337435
| [[ListBox class/EditRow property|EditRow]]
|The row of the current text entry. A value of 0 indicates the top row. A value of &#8211;1 indicates the column header. A value of &#8211;2 indicates that no edits are being made to the text of the control.
 
Before you use this property to set text focus on a control, set key focus of the control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337437
| [[ListBox class/FocusRow property|FocusRow]]
|
|R/W
|X
|- style="background-color:#CCFFFF;"
|6337425
| [[ListBox class/Is Array? property|Is Array?]]
|Returns TRUE if the listbox has an array data type.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337409
| [[ListBox class/ItemNames property|ItemNames]]
|Array of the strings for the selectable items.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633740A
| [[ListBox class/ItemSyms property|ItemSyms]]
|Array of item symbols. Item symbols (0-40) are as shown in the listbox symbol ring constant.
 
This property is similar to the Item Symbols item on the shortcut menu of a listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337404
| [[ListBox class/KBrdMode property|KBrdMode]]
|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).
 
This property is similar to the Keyboard Mode item on the shortcut menu of a listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337427
| [[ListBox class/MultilineInput property|MultilineInput]]
|If TRUE, you can enter multiple lines of text in the listbox cells by pressing the  key on the keyboard. If FALSE, pressing the  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.
 
This property is similar to the Multi-line Input item on the shortcut menu of a single-column listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337401
| [[ListBox class/NumRows property|NumRows]]
|Number of visible items in the listbox. This property counts partially visible rows.
 
If you wire a value of 0 to this property, LabVIEW displays the topmost row. The listbox resizes according to the number of rows you set.
|R/W
|X
|- style="background-color:#CCFFFF;"
|6337434
| [[ListBox class/SelectEntireRows property|SelectEntireRows]]
|Highlights the entire row if you select a row in the tree.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337426
| [[ListBox class/SelColor property|SelColor]]
|Color used to draw the data selection.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337403
| [[ListBox class/SelMode property|SelMode]]
|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).
 
A single-selection listbox has a scalar data type, and a multiple-selection listbox has an array data type. If you set this property for a single-selection listbox to a value of 2 or 3, LabVIEW returns an error because LabVIEW cannot change the data type from scalar to array at run time.
 
This property is similar to the Selection Mode item on the shortcut menu of a listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633740D
| [[ListBox class/Size property|Size]]
|The width and height in pixels of the listbox control.
 
This property is similar to the <b>Size Height</b> and <b>Size Width</b> options on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633740F
| [[ListBox class/Height property|Height]]
|The height of the listbox control in pixels.
 
This property is an element of the Size property. This property is also similar to the <b>Size Height</b> option on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633740E
| [[ListBox class/Width property|Width]]
|The width of the listbox control in pixels.
 
This property is an element of the Size property. This property is also similar to the <b>Size Width</b> option on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337407
| [[ListBox class/TopRow property|TopRow]]
|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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337423
| [[ListBox class/ColHdrVis property|ColHdrVis]]
|If TRUE, displays the column header.
 
This property is similar to the <b>Visible Items&#0187;</b>Column Header item on the shortcut menu of a single-column listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|633742F
| [[ListBox class/Horizontal Lines Visible property|Horizontal Lines Visible]]
|If TRUE, displays horizontal lines that separate rows in the listbox.
 
This property is similar to the <b>Visible Items&#0187;</b>Horizontal Lines item on the shortcut menu of a listbox and the <b>Show horizontal lines</b> option on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337406
| [[ListBox class/SymsVis property|SymsVis]]
|If TRUE, displays the item symbols.
 
This property is similar to the <b>Visible Items&#0187;</b>Symbols item on the shortcut menu of a listbox and the <b>Show symbols</b> option on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|6337405
| [[ListBox class/ScrollVis property|ScrollVis]]
|If TRUE, displays the vertical scroll bar.
 
This property is similar to the <b>Visible Items&#0187;</b>Vertical Scrollbar item on the shortcut menu of a listbox.
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide ListBox Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ ListBox Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|6337002
| [[ListBox class/Custom Item Symbols.Get Symbol method|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.
 
The cluster returned by this method is similar to the image data output of the Read JPEG File, Read PNG File, and Read BMP File VIs.
|X
|- style="background-color:#FFFFCC;"
|6337003
| [[ListBox class/Custom Item Symbols.Get Symbol Array method|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.
 
The clusters returned by this method are similar to the image data output of the Read JPEG File, Read PNG File, and Read BMP File VIs.
|X
|- style="background-color:#FFFFCC;"
|6337007
| [[ListBox class/Custom Item Symbols.Revert Symbols method|Custom Item Symbols.Revert Symbols]]
|Resets all item symbols to the default symbols.
 
You can use a listbox symbol ring constant to view the default item symbols.
|X
|- style="background-color:#FFFFCC;"
|6337006
| [[ListBox class/Custom Item Symbols.Revert Symbol method|Custom Item Symbols.Revert Symbol]]
|Resets an item symbol to the default symbol for its index.
|X
|- style="background-color:#FFFFCC;"
|6337004
| [[ListBox class/Custom Item Symbols.Set Symbol method|Custom Item Symbols.Set Symbol]]
|Sets the image of an item symbol.
 
If you want to use a picture to set the symbol, use the Picture to Pixmap VI to convert the data to an <b>image data</b> cluster before using this method. The <b>image</b> cluster you wire to this method is similar to the <b>image data</b> input of the Write JPEG File, Write PNG File, and Write BMP File VIs.
|X
|- style="background-color:#FFFFCC;"
|6337005
| [[ListBox class/Custom Item Symbols.Set Symbol Array method|Custom Item Symbols.Set Symbol Array]]
|Sets the images of all item symbols.
 
If you want to use a picture to set the symbols, use the Picture to Pixmap VI to convert the data to an <b>image data</b> cluster before using this method. The <b>image</b> clusters you wire to this method are similar to the <b>image data</b> input of the Write JPEG File, Write PNG File, and Write BMP File VIs.
|X
|- style="background-color:#FFFFCC;"
|6337001
| [[ListBox class/Get DblClk Row method|Get DblClk Row]]
|Gets the row number the user double-clicked. The first row on the top is numbered zero. A value of &#8211;2 means that no row has been double-clicked. After this method reads the value, it changes the value back to &#8211;2. This method does not respond to a double-click on the header.
|X
|- style="background-color:#FFFFCC;"
|6337000
| [[ListBox class/Point To Row method|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.
|X
|}
</div>
 
==Events==
<span class="mw-customtoggle-eventstable">Show/Hide ListBox Events Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
{{VIServerLegend}}
{| class="wikitable sortable"
|+ ListBox Events Table
! Code
! Name
! Type
|- style="background-color:#FFFFCC;"
|1073741837
|[[ListBox class/Double Click event|Double Click]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741880
|[[ListBox class/Edit Cell event|Edit Cell]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483703
|[[ListBox class/Edit Cell? event|Edit Cell?]]
|Filter
|}
</div>


== History ==
== History ==

Revision as of 22:15, 8 September 2019

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).

Properties

Show/Hide ListBox Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
ListBox Properties Table
Property ID Long Name (English) Description R/W RTE
6337401Number of RowsNumber of visible items in the listbox. This property counts partially visible rows.Read/WriteYes
6337402Pixel WidthRead/WriteYes
6337403Selection ModeNumber 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/WriteYes
6337404Keyboard ModeSets 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/WriteYes
6337405Visible Items:Vertical Scrollbar VisibleIf TRUE, displays the vertical scroll bar.Read/WriteYes
6337406Visible Items:Symbols VisibleIf TRUE, displays the item symbols.Read/WriteYes
6337407Top RowRow 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/WriteYes
6337408Double-ClickRead OnlyYes
6337409Item NamesArray of the strings for the selectable items.Read/WriteYes
633740AItem SymbolsArray of item symbols. Item symbols (0-40) are as shown in the listbox symbol ring constant.Read/WriteYes
633740BDisabled ItemsArray of indexes of disabled items (first item is 0).Read/WriteYes
633740DSizeThe width and height in pixels of the listbox control.Read/WriteYes
633740ESize:WidthThe width of the listbox control in pixels.Read/WriteYes
633740FSize:HeightThe height of the listbox control in pixels.Read/WriteYes
6337410Content Rect PositionThe 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 OnlyYes
6337411Content Rect Position:LeftThe coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the listbox control.Read OnlyYes
6337412Content Rect Position:TopThe coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the listbox control.Read OnlyYes
6337413Content Rect BoundsThe size in pixels of the content rectangle of the listbox control.Read OnlyYes
6337414Content Rect Bounds:WidthThe width in pixels of the content rectangle of the listbox control.Read OnlyYes
6337415Content Rect Bounds:HeightThe height in pixels of the content rectangle of the listbox control.Read OnlyYes
6337416Active Row:Cell FontThe font of the active cell in the listbox control.Read/WriteYes
6337417Active Row:Cell Font:NameThe name of the font in the active cell. Predefined font names include App Font, Sys Font, and Dlg Font.Read/WriteYes
6337418Active Row:Cell Font:SizeThe size of the font in the active cell.Read/WriteYes
6337419Active Row:Cell Font:BoldIndicates whether the text in the active cell is bold.Read/WriteYes
633741AActive Row:Cell Font:ItalicIndicates whether the text in the active cell is italic.Read/WriteYes
633741BActive Row:Cell Font:UnderlineIndicates whether the text in the active cell is underlined.Read/WriteYes
633741CActive Row:Cell Font:StrikeoutIndicates whether to strike out the text in the active cell.Read/WriteYes
633741DActive Row:Cell Font:ColorThe text font color in the active cell.Read/WriteYes
633741EActive Row:Cell Justification (Deprecated)Read/WriteYes
633741FAllow Dragging (Deprecated)Read/WriteYes
6337420Allow Editing CellsIf 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/WriteYes
6337421Old Edit RowRead/WriteYes
6337423Visible Items:Column Header VisibleIf TRUE, displays the column header.Read/WriteYes
6337424Column Header StringThe string in the column header.Read/WriteYes
6337425Is Array?Returns TRUE if the listbox has an array data type.Read/WriteYes
6337426Selection ColorColor used to draw the data selection.Read/WriteYes
6337427Multiple Line InputIf 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/WriteYes
6337428Autosizing Row HeightDetermines whether the rows autosize their height to display all text when fonts change or when the number of lines in a cell changes.Read/WriteYes
6337429Active Row:Active Row NumberSets the active row. A value of –1 indicates the column header. A value of –2 indicates all rows.Read/WriteYes
633742AActive Row:Cell HeightThe height of the active cell(s) in pixels.Read/WriteYes
633742BActive Row:Active Row PositionThe coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active row(s).Read OnlyYes
633742CActive Row:Active Row Position:LeftThe coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active row.Read OnlyYes
633742DActive Row:Active Row Position:TopThe coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active row.Read OnlyYes
633742EActive Row:Cell Background ColorThe background color of the active cell(s).Read/WriteYes
633742FVisible Items:Horizontal Lines VisibleIf TRUE, displays horizontal lines that separate rows in the listbox.Read/WriteYes
6337430Drag/Drop:Allow DraggingIf 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/WriteYes
6337431Drag/Drop:Allow DroppingIf 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/WriteYes
6337432Drag/Drop:Drag ModeSets 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/WriteYes
6337433Drag/Drop:Allow Drag and Drop Outside ControlIf TRUE, this enables the control to drag items to other controls and accept drags from other controls.Read/WriteYes
6337434Select Entire RowsHighlights the entire row if you select a row in the tree.Read/WriteYes
6337435Edit RowThe 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/WriteYes
6337436Active Row:Cell JustificationGets or sets the justification of text within the active row of the listbox.Read/WriteYes
6337437Focus RowRead/WriteYes

Methods

Show/Hide ListBox Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
ListBox Methods Table
Method ID Long Name (English) Description RTE
6337000Point to RowConverts 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)
6337001Get Double-Clicked RowGets 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)
6337002Custom Item Symbols:Get SymbolReturns 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)
6337003Custom Item Symbols:Get Symbol ArrayReturns 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)
6337004Custom Item Symbols:Set To Custom SymbolSets the image of an item symbol.Yes (Read/Write)
6337005Custom Item Symbols:Set To Custom Symbol ArraySets the images of all item symbols.Yes (Read/Write)
6337006Custom Item Symbols:Revert To Built In SymbolResets an item symbol to the default symbol for its index.Yes (Read/Write)
6337007Custom Item Symbols:Revert All To Built In SymbolsResets all item symbols to the default symbols.Yes (Read/Write)

Events

Show/Hide ListBox Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
ListBox Events Table
Code Name Description Type
1073741837Double ClickGenerated when a user double-clicks an item in a listbox.Notify
1073741880Edit CellGenerated when the user enters new text or changes text in a cell.Notify
2147483703Edit 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)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=ListBox_class&oldid=9768"