Jump to content

ListBox class

From LabVIEW Wiki
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.


    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

    Version Change(s)
    LabVIEW 2018 More info to come.

    See Also