MulticolumnListbox class

From LabVIEW Wiki
Jump to: navigation, search
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.


The MulticolumnListbox class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide MulticolumnListbox Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
MulticolumnListbox Properties Table
Property ID Long Name (English) Description R/W RTE
18D99000Item NamesThe strings for the selectable items in a two-dimensional array for rows and columns.Read/WriteYes
18D99001Item SymbolsArray of item symbols. Item symbols (0-40) are as shown in the listbox symbol ring constant.Read/WriteYes
18D99002Disabled ItemsArray of indexes of disabled rows (first row is 0).Read/WriteYes
18D99005Column Header Strings[]An array of the strings in the column headers.Read/WriteYes
18D99006Visible Items:Symbols VisibleIf TRUE, displays the item symbols.Read/WriteYes
18D99007Visible Items:Vertical Scrollbar VisibleIf TRUE, displays the vertical scroll bar.Read/WriteYes
18D99008Visible Items:Horizontal Scrollbar VisibleIf TRUE, displays the horizontal scroll bar.Read/WriteYes
18D99009Number of RowsNumber of visible rows in the multicolumn listbox, excluding column headers. This property counts partially visible rows.Read/WriteYes
18D9900ANumber of ColumnsNumber of visible columns in the multicolumn listbox. This property counts partially visible columns.Read/WriteYes
18D9900BVisible Items:Column Headers VisibleIf TRUE, displays the column headers.Read/WriteYes
18D9900CTop Left Visible CellThe 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/WriteYes
18D9900DSelection 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
18D9900EActive Cell:Active CellSets the row and column of the active cell(s).Read/WriteYes
18D9900FActive Cell:Cell Foreground ColorRead/WriteYes
18D99010Active Cell:Cell Background ColorThe background color of the active cell(s).Read/WriteYes
18D99011Active Cell:Cell SizeThe size of the active cell(s) in pixels.Read/WriteYes
18D99012Active Cell:Cell Size:WidthThe width of the active cell(s) in pixels.Read/WriteYes
18D99013Active Cell:Cell Size:HeightThe height of the active cell(s) in pixels.Read/WriteYes
18D99014Selection ColorThe color used to highlight the selected items.Read/WriteYes
18D99015Autosizing 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
18D99016Smooth Horizontal ScrollingIf 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/WriteYes
18D99017Multiple 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
18D99018Selected CellRead/WriteYes
18D99019SizeThe width and height in pixels of the multicolumn listbox control.Read/WriteYes
18D9901ASize:WidthThe width of the active cell(s) in pixels.Read/WriteYes
18D9901BSize:HeightThe height of the active cell(s) in pixels.Read/WriteYes
18D9901CContent Rect PositionThe 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 OnlyYes
18D9901DContent Rect Position:LeftThe 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 OnlyYes
18D9901EContent Rect Position:TopThe 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 OnlyYes
18D9901FContent Rect BoundsThe size in pixels of the content rectangle of the multicolumn listbox control.Read OnlyYes
18D99020Content Rect Bounds:WidthThe width in pixels of the content rectangle of the multicolumn listbox control.Read OnlyYes
18D99021Content Rect Bounds:HeightThe height in pixels of the content rectangle of the multicolumn listbox control.Read OnlyYes
18D99022Active Cell:PositionThe coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active cell(s).Read OnlyYes
18D99023Active Cell:Position:LeftThe coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell.Read OnlyYes
18D99024Active Cell:Position:TopThe coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell.Read OnlyYes
18D99025Active Cell:Cell FontThe font of the active cell in the multicolumn listbox control.Read/WriteYes
18D99026Active Cell:Cell Font:NameThe name of the font in the active cell. Predefined font names include App Font, Sys Font, and Dlg Font.Read/WriteYes
18D99027Active Cell:Cell Font:SizeThe size of the font in the active cell.Read/WriteYes
18D99028Active Cell:Cell Font:BoldIndicates whether the text in the active cell is bold.Read/WriteYes
18D99029Active Cell:Cell Font:ItalicIndicates whether the text in the active cell is italic.Read/WriteYes
18D9902AActive Cell:Cell Font:UnderlineIndicates whether the text in the active cell is underlined.Read/WriteYes
18D9902BActive Cell:Cell Font:StrikeoutIndicates whether to strike out the text in the active cell.Read/WriteYes
18D9902CActive Cell:Cell Font:ColorThe text font color in the active cell.Read/WriteYes
18D9902DActive Cell:Cell JustificationGets and sets the justification of text within a table cell.Read/WriteYes
18D9902EDrag/Drop:Allow Dragging (Deprecated)Read/WriteYes
18D9902FAllow Editing CellsIf 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/WriteYes
18D99030Old Edit PositionRead/WriteYes
18D99031Visible Items:Row Headers VisibleShows the row headers.Read/WriteYes
18D99032Row Header Strings[]An array of the strings in the row headers.Read/WriteYes
18D99033Is Array?Returns TRUE if the listbox has an array data type.Read/WriteYes
18D99034Keyboard ModeSets 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/WriteYes
18D99035Visible Items:Vertical Lines VisibleIf TRUE, displays vertical lines that separate columns in the multicolumn listbox.Read/WriteYes
18D99036Visible Items:Horizontal Lines VisibleIf TRUE, displays horizontal lines that separate rows in the multicolumn listbox.Read/WriteYes
18D99037Drag/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
18D99038Drag/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 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/WriteYes
18D99039Drag/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
18D9903ADrag/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
18D9903BSelect Entire RowsHighlights the entire row if you select a row in the tree.Read/WriteYes
18D9903CEdit PositionThe 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/WriteYes
18D9903DFocus RowRead/WriteYes
18D9903EBulk Cells:Background ColorWrite OnlyYes
18D9903FBulk Cells:Font ColorWrite OnlyYes

Methods

Show/Hide MulticolumnListbox Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
MulticolumnListbox Methods Table
Method ID Long Name (English) Description RTE
18D99400Get 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)
18D99401Get Clicked Column HeaderGet 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 (Read/Write)
18D99402Point to Row ColumnConverts 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 (Read/Write)
18D99403Custom 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)
18D99404Custom 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)
18D99405Custom Item Symbols:Set To Custom SymbolSets the image of an item symbol.Yes (Read/Write)
18D99406Custom Item Symbols:Set To Custom Symbol ArraySets the images of all item symbols.Yes (Read/Write)
18D99407Custom Item Symbols:Revert To Built In SymbolResets an item symbol to the default symbol for its index.Yes (Read/Write)
18D99408Custom Item Symbols:Revert All To Built In SymbolsResets all item symbols to the default symbols.Yes (Read/Write)

Events

Show/Hide MulticolumnListbox Events Table

Legend
Basic Development Environment
VI Scripting
Private
Deprecated
MulticolumnListbox Events Table
Code Name Description Type
1073741837Double ClickGenerated 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
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