Jump to content

MulticolumnListbox class: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
Visual
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 MulticolumnListbox Properties Table</span>
{{VIServerClassTables|46}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ MulticolumnListbox Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|18D9900E
| [[MulticolumnListbox class/ActiveCell property|ActiveCell]]
|Sets the row and column of the active cell(s).
 
{| 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;"|Row
|Sets the row(s) of the active cell(s). Possible values are 0…n, where n is the total number of rows - 1. Enter &#8211;2 to select all rows.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Column
|Sets the column(s) of the active cell(s).  Possible values are 0…m, where m is the total number of columns - 1. Enter &#8211;2 to select all columns. Enter &#8211;1 to select the column header.
|}
 
The following table lists example values for this property.
 
{| class="wikitable"
! scope="col" style="text-align:left;"| Row
! scope="col" style="text-align:left;"| Column
! scope="col" style="text-align:left;"| Result
|- style="vertical-align:top;"
| -2
| 0
| Selects all cells in the first column, including the column header.
|- style="vertical-align:top;"
| -2
| -2
| Selects all rows and columns, including column headers.
|- style="vertical-align:top;"
| -1
| 0
| Selects the header of the first column.
|- style="vertical-align:top;"
| -1
| -2
| Selects the headers of all columns
|- style="vertical-align:top;".
| 0
| -2
| Selects all cells of the first row, including the row header.
|- style="vertical-align:top;"
| 0
| -1
| Selects the header of the first row.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99010
| [[MulticolumnListbox 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;"
|18D99025
| [[MulticolumnListbox class/CellFont property|CellFont]]
|The font of the active cell in the multicolumn 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.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99028
| [[MulticolumnListbox class/CellFontBold property|CellFontBold]]
|Indicates whether the text in the active cell is bold.
 
This property is an element of the Active Cell:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9902C
| [[MulticolumnListbox class/CellFontColor property|CellFontColor]]
|The text font color in the active cell.
 
This property is an element of the Active Cell:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99029
| [[MulticolumnListbox class/CellFontItalic property|CellFontItalic]]
|Indicates whether the text in the active cell is italic.
 
This property is an element of the Active Cell:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99026
| [[MulticolumnListbox 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 Cell:Cell Font property.
 
If you select an invalid font, this property returns an error.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99027
| [[MulticolumnListbox class/CellFontSize property|CellFontSize]]
|The size of the font in the active cell.
 
This property is an element of the Active Cell:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9902B
| [[MulticolumnListbox class/CellFontStrike property|CellFontStrike]]
|Indicates whether to strike out the text in the active cell.
 
This property is an element of the Active Cell:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9902A
| [[MulticolumnListbox class/CellFontUnder property|CellFontUnder]]
|Indicates whether the text in the active cell is underlined.
 
This property is an element of the Active Cell:Cell Font property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9902D
| [[MulticolumnListbox class/CellJustify property|CellJustify]]
|Gets and sets the justification of text within a table cell.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99011
| [[MulticolumnListbox class/CellSize property|CellSize]]
|The size of the active cell(s) in pixels.
 
Changing the cell size does not change the size of the multicolumn listbox control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99013
| [[MulticolumnListbox class/Height property|Height]]
|The height of the active cell(s) in pixels.
 
This property is an element of the Active Cell:Cell Size property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99012
| [[MulticolumnListbox class/Width property|Width]]
|The width of the active cell(s) in pixels.
 
This property is an element of the Active Cell:Cell Size property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99022
| [[MulticolumnListbox class/ActiveCellPos property|ActiveCellPos]]
|The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active cell(s).
|R
|X
|- style="background-color:#FFFFCC;"
|18D99023
| [[MulticolumnListbox class/ActiveCellPosLeft property|ActiveCellPosLeft]]
|The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell.
 
This property is an element of the Active Cell:Position property.
|R
|X
|- style="background-color:#FFFFCC;"
|18D99024
| [[MulticolumnListbox class/ActiveCellPosTop property|ActiveCellPosTop]]
|The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell.
 
This property is an element of the Active Cell:Position property.
|R
|X
|- style="background-color:#FFFFCC;"
|18D9902F
| [[MulticolumnListbox class/Allow Editing Cells property|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.
 
This property is similar to the Editable Cells item on the shortcut menu of a multicolumn listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99015
| [[MulticolumnListbox 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 multicolumn 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 multicolumn listbox.
|R/W
|X
|- style="background-color:#D1BB80;"
|18D9903E
| [[MulticolumnListbox class/CellBGColors property|CellBGColors]]
|
|W
|X
|- style="background-color:#D1BB80;"
|18D9903F
| [[MulticolumnListbox class/CellFontColors property|CellFontColors]]
|
|W
|X
|- style="background-color:#FFFFCC;"
|18D99005
| [[MulticolumnListbox class/ColHdrs() property|ColHdrs()]]
|An array of the strings in the column headers.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9901F
| [[MulticolumnListbox class/ContentRectBounds property|ContentRectBounds]]
|The size in pixels of the content rectangle of the multicolumn listbox control.
|R
|X
|- style="background-color:#FFFFCC;"
|18D99021
| [[MulticolumnListbox class/ContentRectBoundsHeight property|ContentRectBoundsHeight]]
|The height in pixels of the content rectangle of the multicolumn listbox control.
 
This property is an element of the Content Rect Bounds property.
|R
|X
|- style="background-color:#FFFFCC;"
|18D99020
| [[MulticolumnListbox class/ContentRectBoundsWidth property|ContentRectBoundsWidth]]
|The width in pixels of the content rectangle of the multicolumn listbox control.
 
This property is an element of the Content Rect Bounds property.
|R
|X
|- style="background-color:#FFFFCC;"
|18D9901C
| [[MulticolumnListbox 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 multicolumn listbox control.
|R
|X
|- style="background-color:#FFFFCC;"
|18D9901D
| [[MulticolumnListbox 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 multicolumn listbox control.
 
This property is an element of the Content Rect Position property.
|R
|X
|- style="background-color:#FFFFCC;"
|18D9901E
| [[MulticolumnListbox 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 multicolumn listbox control.
 
This property is an element of the Content Rect Position property.
|R
|X
|- style="background-color:#FFFFCC;"
|18D99002
| [[MulticolumnListbox class/DisabledItems property|DisabledItems]]
|Array of indexes of disabled rows (first row 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 multicolumn listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9903A
| [[MulticolumnListbox 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 multicolumn listbox control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99037
| [[MulticolumnListbox class/AllowDragging property|AllowDragging]]
|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 multicolumn listbox control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99038
| [[MulticolumnListbox class/AllowDropping property|AllowDropping]]
|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.
 
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 multicolumn listbox control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99039
| [[MulticolumnListbox class/DragMode property|DragMode]]
|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 multicolumn listbox control.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9903C
| [[MulticolumnListbox class/EditPos property|EditPos]]
|The row-column pair index of the current text entry. Values of (0,0) indicate the top-left text entry. A value of &#8211;1 indicates the row or column header. Values of (&#8211;2, &#8211;2) indicate 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.
 
{| 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;"|Row
|The row of the  current text entry. Possible values are 0…n, where n is the total number of rows - 1.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Column
|The column of the current text entry. Possible values are 0…m, where m is the total number of columns - 1. Enter &#8211;1 to select the column header.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9903D
| [[MulticolumnListbox class/FocusRow property|FocusRow]]
|
|R/W
|X
|- style="background-color:#CCFFFF;"
|18D99033
| [[MulticolumnListbox class/IsArray? property|IsArray?]]
|Returns TRUE if the listbox has an array data type.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99000
| [[MulticolumnListbox class/ItemNames property|ItemNames]]
|The strings for the selectable items in a two-dimensional array for rows and columns.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99001
| [[MulticolumnListbox 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;"
|18D99034
| [[MulticolumnListbox class/KBrdMode property|KBrdMode]]
|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).
 
This property is similar to the Keyboard Mode item on the shortcut menu of a multicolumn listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99017
| [[MulticolumnListbox 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 multicolumn listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9900A
| [[MulticolumnListbox class/NumCols property|NumCols]]
|Number of visible columns in the multicolumn listbox. This property counts partially visible columns.
 
If you wire a value of 0 to this property, LabVIEW displays the leftmost column. The listbox resizes according to the number of columns you set.
 
This property is similar to the <b>Columns</b> option on the Appearance page of the <b>Multicolumn Listbox Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99009
| [[MulticolumnListbox class/NumRows property|NumRows]]
|Number of visible rows in the multicolumn listbox, excluding column headers. This property counts partially visible rows.
 
If you wire a value of 0 to this property, LabVIEW displays the topmost row. The multicolumn listbox resizes according to the number of rows you set.
 
This property is similar to the <b>Rows</b> option on the Appearance page of the <b>Multicolumn Listbox Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99032
| [[MulticolumnListbox class/RowHdrs() property|RowHdrs()]]
|An array of the strings in the row headers.
|R/W
|X
|- style="background-color:#CCFFFF;"
|18D9903B
| [[MulticolumnListbox class/SelectEntireRows property|SelectEntireRows]]
|Highlights the entire row if you select a row in the tree.
|R/W
|X
|- style="background-color:#D1BB80;"
|18D99018
| [[MulticolumnListbox class/SelectedCell property|SelectedCell]]
|
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99014
| [[MulticolumnListbox class/SelColor property|SelColor]]
|The color used to highlight the selected items.
 
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;"
|18D9900D
| [[MulticolumnListbox 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;"
|18D99019
| [[MulticolumnListbox class/Size property|Size]]
|The width and height in pixels of the multicolumn 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;"
|18D9901B
| [[MulticolumnListbox class/Height property|Height]]
|The height of the active cell(s) in pixels.
 
This property is an element of the Active Cell:Cell Size property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9901A
| [[MulticolumnListbox class/Width property|Width]]
|The width of the active cell(s) in pixels.
 
This property is an element of the Active Cell:Cell Size property.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99016
| [[MulticolumnListbox class/SmoothHScroll property|SmoothHScroll]]
|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.
 
This property is similar to the <b>Smooth Scrolling</b> item on the shortcut menu of a multicolumn listbox.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9900C
| [[MulticolumnListbox class/TopLeft property|TopLeft]]
|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.
 
This property returns the row and column of the item string at the top left corner of the visible listbox window, which is not necessarily the top left item of the listbox. To access the top left item, wire a value of (0,0) to the Active Cell property.
 
{| 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;"|Row
|The row index of the cell displayed in the top left corner of the listbox.
|- style="vertical-align:top;"
! scope="row" style="text-align:left;"|Column
|The column index of the cell displayed in the top left corner of the listbox.
|}
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D9900B
| [[MulticolumnListbox class/ColHdrVis property|ColHdrVis]]
|If TRUE, displays the column headers.
 
This property is similar to the <b>Visible Items&#0187;</b>Column Headers item on the shortcut menu of a multicolumn listbox and the <b>Show column headers</b> option on the Appearance page of the Properties dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99036
| [[MulticolumnListbox class/HorizontalLinesVis property|HorizontalLinesVis]]
|If TRUE, displays horizontal lines that separate rows in the multicolumn listbox.
 
This property is similar to the <b>Visible Items&#0187;</b>Horizontal Lines item on the shortcut menu of a multicolumn 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;"
|18D99008
| [[MulticolumnListbox class/HScrollVis property|HScrollVis]]
|If TRUE, displays the horizontal scroll bar.
 
This property is similar to the <b>Visible Items&#0187;</b>Horizontal Scrollbar item on the shortcut menu of a multicolumn listbox and the <b>Show horizontal scroll bar</b> option on the Appearance page of the <b>Multicolumn Listbox Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99031
| [[MulticolumnListbox class/RowHdrVis property|RowHdrVis]]
|Shows the row headers.
 
This property is similar to the <b>Visible Items&#0187;</b>Row Headers item on the shortcut menu of a multicolumn listbox control and to the <b>Show row headers</b> option on the Appearance page of the <b>Multicolumn Listbox Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99006
| [[MulticolumnListbox class/SymbolsVis property|SymbolsVis]]
|If TRUE, displays the item symbols.
 
This property is similar to the Visible Items&#0187;Symbols item on the shortcut menu of a multicolumn 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;"
|18D99035
| [[MulticolumnListbox class/VerticalLinesVis property|VerticalLinesVis]]
|If TRUE, displays vertical lines that separate columns in the multicolumn listbox.
 
This property is similar to the <b>Visible Items&#0187;</b>Vertical Lines item on the shortcut menu of a multicolumn listbox and the <b>Show vertical lines</b> option on the Appearance page of the <b>Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|18D99007
| [[MulticolumnListbox class/VScrollVis property|VScrollVis]]
|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 multicolumn listbox and the <b>Show vertical scroll bar</b> option on the Appearance page of the <b>Multicolumn Listbox Properties</b> dialog box.
|R/W
|X
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide MulticolumnListbox Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ MulticolumnListbox Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
|18D99403
| [[MulticolumnListbox 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;"
|18D99404
| [[MulticolumnListbox 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;"
|18D99408
| [[MulticolumnListbox 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;"
|18D99407
| [[MulticolumnListbox 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;"
|18D99405
| [[MulticolumnListbox 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;"
|18D99406
| [[MulticolumnListbox 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;"
|18D99401
| [[MulticolumnListbox class/Get Clicked Col Hdr method|Get Clicked Col Hdr]]
|Get the column number for which the user clicked the column header. The first column on the left is numbered zero. A value of &#8211;2 means that no column header has been clicked. After this function reads the value, it changes the value back to &#8211;2.
|X
|- style="background-color:#FFFFCC;"
|18D99400
| [[MulticolumnListbox 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;"
|18D99402
| [[MulticolumnListbox class/Point To Row Column method|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.
|X
|}
</div>
 
==Events==
<span class="mw-customtoggle-eventstable">Show/Hide MulticolumnListbox Events Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
{{VIServerLegend}}
{| class="wikitable sortable"
|+ MulticolumnListbox Events Table
! Code
! Name
! Type
|- style="background-color:#FFFFCC;"
|1073741837
|[[MulticolumnListbox class/Double Click event|Double Click]]
|Notify
|- style="background-color:#FFFFCC;"
|1073741880
|[[MulticolumnListbox class/Edit Cell event|Edit Cell]]
|Notify
|- style="background-color:#FFFFCC;"
|2147483703
|[[MulticolumnListbox class/Edit Cell? event|Edit Cell?]]
|Filter
|}
</div>


== History ==
== History ==

Revision as of 22:17, 8 September 2019

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

    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

    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=MulticolumnListbox_class&oldid=9772"