Jump to content

MulticolumnListbox class: Difference between revisions

From LabVIEW Wiki
← Older edit
Visual
m Removed VI Server Category from page
Removed template
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
== Properties ==
{{VIServerClassTables|46}}
<span class="mw-customtoggle-propertiestable">Show/Hide MulticolumnListbox Properties Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"
|+ MulticolumnListbox Properties Table
! data-sort-type="number"| Property ID
! Long Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
| data-sort-value=416911360 |18D99000
| [[MulticolumnListbox class/Item Names property|Item Names]]
| The strings for the selectable items in a two-dimensional array for rows and columns.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911361 |18D99001
| [[MulticolumnListbox class/Item Symbols property|Item Symbols]]
| Array of item symbols. Item symbols (0-40) are as shown in the [[listbox symbol ring]] constant.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911362 |18D99002
| [[MulticolumnListbox class/Disabled Items property|Disabled Items]]
| Array of indexes of disabled rows (first row is 0).
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911365 |18D99005
| [[MulticolumnListbox class/Column Header Strings() property|Column Header Strings[]]]
| An array of the strings in the column headers.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911366 |18D99006
| [[MulticolumnListbox class/Visible Items.Symbols Visible property|Visible Items:Symbols Visible]]
| If TRUE, displays the item symbols.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911367 |18D99007
| [[MulticolumnListbox class/Visible Items.Vertical Scrollbar Visible property|Visible Items:Vertical Scrollbar Visible]]
| If TRUE, displays the vertical scroll bar.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911368 |18D99008
| [[MulticolumnListbox class/Visible Items.Horizontal Scrollbar Visible property|Visible Items:Horizontal Scrollbar Visible]]
| If TRUE, displays the horizontal scroll bar.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911369 |18D99009
| [[MulticolumnListbox class/Number of Rows property|Number of Rows]]
| Number of visible rows in the multicolumn listbox, excluding column headers. This property counts partially visible rows.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911370 |18D9900A
| [[MulticolumnListbox class/Number of Columns property|Number of Columns]]
| Number of visible columns in the multicolumn listbox. This property counts partially visible columns.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911371 |18D9900B
| [[MulticolumnListbox class/Visible Items.Column Headers Visible property|Visible Items:Column Headers Visible]]
| If TRUE, displays the column headers.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911372 |18D9900C
| [[MulticolumnListbox class/Top Left Visible Cell property|Top Left Visible Cell]]
| The row and column of the item string displayed in the top left corner of the listbox. Use this property to read or change the top item, or use it to read or change the leftmost column of information displayed.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911373 |18D9900D
| [[MulticolumnListbox class/Selection Mode property|Selection Mode]]
| Number of items the user can select. Valid values include 0 (zero or one), 1 (one), 2 (zero or more), and 3 (one or more).
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911374 |18D9900E
| [[MulticolumnListbox class/Active Cell.Active Cell property|Active Cell:Active Cell]]
| Sets the row and column of the active cell(s).
| Read/Write
| Yes
|- style="background-color:#FFAAAA;"
| data-sort-value=416911375 |18D9900F
| [[MulticolumnListbox class/Active Cell.Cell Foreground Color property|Active Cell:Cell Foreground Color]]
|
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911376 |18D99010
| [[MulticolumnListbox class/Active Cell.Cell Background Color property|Active Cell:Cell Background Color]]
| The background color of the active cell(s).
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911377 |18D99011
| [[MulticolumnListbox class/Active Cell.Cell Size property|Active Cell:Cell Size]]
| The size of the active cell(s) in pixels.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911378 |18D99012
| [[MulticolumnListbox class/Active Cell.Cell Size.Width property|Active Cell:Cell Size:Width]]
| The width of the active cell(s) in pixels.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911379 |18D99013
| [[MulticolumnListbox class/Active Cell.Cell Size.Height property|Active Cell:Cell Size:Height]]
| The height of the active cell(s) in pixels.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911380 |18D99014
| [[MulticolumnListbox class/Selection Color property|Selection Color]]
| The color used to highlight the selected items.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911381 |18D99015
| [[MulticolumnListbox class/Autosizing Row Height property|Autosizing Row Height]]
| Determines whether the rows autosize their height to display all text when fonts change or when the number of lines in a cell changes.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911382 |18D99016
| [[MulticolumnListbox class/Smooth Horizontal Scrolling property|Smooth Horizontal Scrolling]]
| If TRUE, the horizontal scrolling of the listbox is by pixels, such that the first column may be horizontally clipped. If FALSE, the listbox scrolls by whole column widths such that the first column is never clipped. However, if a column is wider than the width of the listbox, you cannot see the text that is hidden off the right edge of that column.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911383 |18D99017
| [[MulticolumnListbox class/Multiple Line Input property|Multiple Line Input]]
| If TRUE, you can enter multiple lines of text in the listbox cells by pressing the <Enter> key on the keyboard. If FALSE, pressing the <Enter> key on the keyboard while editing cells causes LabVIEW to commit the edits in the current cell and move the text focus to the next cell. This property does not affect run-time behavior of the listbox.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911384 |18D99018
| [[MulticolumnListbox class/Selected Cell property|Selected Cell]]
| Reads or writes the row and column of the most recently selected cell in the multicolumn listbox.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911385 |18D99019
| [[MulticolumnListbox class/Size property|Size]]
| The width and height in pixels of the multicolumn listbox control.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911386 |18D9901A
| [[MulticolumnListbox class/Size.Width property|Size:Width]]
| The width of the active cell(s) in pixels.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911387 |18D9901B
| [[MulticolumnListbox class/Size.Height property|Size:Height]]
| The height of the active cell(s) in pixels.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911388 |18D9901C
| [[MulticolumnListbox class/Content Rect Position property|Content Rect Position]]
| The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the content rectangle of the multicolumn listbox control.
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911389 |18D9901D
| [[MulticolumnListbox class/Content Rect Position.Left property|Content Rect Position:Left]]
| The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the multicolumn listbox control.
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911390 |18D9901E
| [[MulticolumnListbox class/Content Rect Position.Top property|Content Rect Position:Top]]
| The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the multicolumn listbox control.
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911391 |18D9901F
| [[MulticolumnListbox class/Content Rect Bounds property|Content Rect Bounds]]
| The size in pixels of the content rectangle of the multicolumn listbox control.
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911392 |18D99020
| [[MulticolumnListbox class/Content Rect Bounds.Width property|Content Rect Bounds:Width]]
| The width in pixels of the content rectangle of the multicolumn listbox control.
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911393 |18D99021
| [[MulticolumnListbox class/Content Rect Bounds.Height property|Content Rect Bounds:Height]]
| The height in pixels of the content rectangle of the multicolumn listbox control.
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911394 |18D99022
| [[MulticolumnListbox class/Active Cell.Position property|Active Cell:Position]]
| The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active cell(s).
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911395 |18D99023
| [[MulticolumnListbox class/Active Cell.Position.Left property|Active Cell:Position:Left]]
| The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell.
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911396 |18D99024
| [[MulticolumnListbox class/Active Cell.Position.Top property|Active Cell:Position:Top]]
| The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell.
| Read Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911397 |18D99025
| [[MulticolumnListbox class/Active Cell.Cell Font property|Active Cell:Cell Font]]
| The font of the active cell in the multicolumn listbox control.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911398 |18D99026
| [[MulticolumnListbox class/Active Cell.Cell Font.Name property|Active Cell:Cell Font:Name]]
| The name of the font in the active cell. Predefined font names include <code>App Font</code>, <code>Sys Font</code>, and <code>Dlg Font</code>.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911399 |18D99027
| [[MulticolumnListbox class/Active Cell.Cell Font.Size property|Active Cell:Cell Font:Size]]
| The size of the font in the active cell.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911400 |18D99028
| [[MulticolumnListbox class/Active Cell.Cell Font.Bold property|Active Cell:Cell Font:Bold]]
| Indicates whether the text in the active cell is bold.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911401 |18D99029
| [[MulticolumnListbox class/Active Cell.Cell Font.Italic property|Active Cell:Cell Font:Italic]]
| Indicates whether the text in the active cell is italic.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911402 |18D9902A
| [[MulticolumnListbox class/Active Cell.Cell Font.Underline property|Active Cell:Cell Font:Underline]]
| Indicates whether the text in the active cell is underlined.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911403 |18D9902B
| [[MulticolumnListbox class/Active Cell.Cell Font.Strikeout property|Active Cell:Cell Font:Strikeout]]
| Indicates whether to strike out the text in the active cell.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911404 |18D9902C
| [[MulticolumnListbox class/Active Cell.Cell Font.Color property|Active Cell:Cell Font:Color]]
| The text font color in the active cell.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911405 |18D9902D
| [[MulticolumnListbox class/Active Cell.Cell Justification property|Active Cell:Cell Justification]]
| Gets and sets the justification of text within a table cell.
| Read/Write
| Yes
|- style="background-color:#FFAAAA;"
| data-sort-value=416911406 |18D9902E
| [[MulticolumnListbox class/Drag/Drop.Allow Dragging (Deprecated) property|Drag/Drop:Allow Dragging (Deprecated)]]
|
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911407 |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.
| Read/Write
| Yes
|- style="background-color:#FFAAAA;"
| data-sort-value=416911408 |18D99030
| [[MulticolumnListbox class/Old Edit Position property|Old Edit Position]]
|
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911409 |18D99031
| [[MulticolumnListbox class/Visible Items.Row Headers Visible property|Visible Items:Row Headers Visible]]
| Shows the row headers.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911410 |18D99032
| [[MulticolumnListbox class/Row Header Strings() property|Row Header Strings[]]]
| An array of the strings in the row headers.
| Read/Write
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=416911411 |18D99033
| [[MulticolumnListbox class/Is Array? property|Is Array?]]
| Returns TRUE if the listbox has an array data type.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911412 |18D99034
| [[MulticolumnListbox class/Keyboard Mode property|Keyboard Mode]]
| Sets how to handle upper and lowercase characters when you type characters in a multicolumn listbox at run time. Valid values include 0 (System Default), 1 (Case Sensitive), and 2 (Case Insensitive).
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911413 |18D99035
| [[MulticolumnListbox class/Visible Items.Vertical Lines Visible property|Visible Items:Vertical Lines Visible]]
| If TRUE, displays vertical lines that separate columns in the multicolumn listbox.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911414 |18D99036
| [[MulticolumnListbox class/Visible Items.Horizontal Lines Visible property|Visible Items:Horizontal Lines Visible]]
| If TRUE, displays horizontal lines that separate rows in the multicolumn listbox.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911415 |18D99037
| [[MulticolumnListbox class/Drag/Drop.Allow Dragging property|Drag/Drop:Allow Dragging]]
| If TRUE, LabVIEW automatically begins a drag and drop operation from the control when you use the Operating tool to select and drag an item from the control.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911416 |18D99038
| [[MulticolumnListbox class/Drag/Drop.Allow Dropping property|Drag/Drop:Allow Dropping]]
| If TRUE, LabVIEW automatically accepts drops containing the <code>LV_LISTBOX</code>, <code>LV_TEXT</code>, or <code>LV_LISTBOX_ITEMS</code> data types. The <code>LV_LISTBOX</code> 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 <code>LV_TEXT</code> data type is of type string. The <code>LV_LISTBOX_ITEMS</code> data type is an array of a cluster containing an array of strings, from left to right, in the item you are dragging and an integer representing the glyph index associated with the item from which you are dragging data.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911417 |18D99039
| [[MulticolumnListbox class/Drag/Drop.Drag Mode property|Drag/Drop:Drag Mode]]
| Sets the default behavior for a drag and drop operation for the control. The settings apply only when the control configured is the source of the drag and drop operation.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911418 |18D9903A
| [[MulticolumnListbox class/Drag/Drop.Allow Drag and Drop Outside Control property|Drag/Drop:Allow Drag and Drop Outside Control]]
| If TRUE, this enables the control to drag items to other controls and accept drags from other controls.
| Read/Write
| Yes
|- style="background-color:#CCFFFF;"
| data-sort-value=416911419 |18D9903B
| [[MulticolumnListbox class/Select Entire Rows property|Select Entire Rows]]
| Highlights the entire row if you select a row in the tree.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911420 |18D9903C
| [[MulticolumnListbox class/Edit Position property|Edit Position]]
| The row-column pair index of the current text entry. Values of (0,0) indicate the top-left text entry. A value of -1 indicates the row or column header. Values of (-2, -2) indicate that no edits are being made to the text of the control.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911421 |18D9903D
| [[MulticolumnListbox class/Focus Row property|Focus Row]]
| The focus row, used as the basis for key navigation such as the up and down arrows.
| Read/Write
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911422 |18D9903E
| [[MulticolumnListbox class/Bulk Cells.Background Colors property|Bulk Cells:Background Colors]]
| Writes the background colors for a group of cells in the multicolumn listbox.
| Write Only
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416911423 |18D9903F
| [[MulticolumnListbox class/Bulk Cells.Font Colors property|Bulk Cells:Font Colors]]
| Writes the font colors for a group of cells in the multicolumn listbox.
| Write Only
| Yes
|}
</div></div>
 
== Methods ==
<span class="mw-customtoggle-methodstable">Show/Hide MulticolumnListbox Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"
|+ MulticolumnListbox Methods Table
! data-sort-type="number"| Property ID
! Long Name (English)
! Description
! RTE
|- style="background-color:#FFFFCC;"
| data-sort-value=416912384 |18D99400
| [[MulticolumnListbox class/Get Double-Clicked Row method|Get Double-Clicked Row]]
| Gets the row number the user double-clicked. The first row on the top is numbered zero. A value of -2 means that no row has been double-clicked. After this method reads the value, it changes the value back to -2. This method does not respond to a double-click on the header.
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416912385 |18D99401
| [[MulticolumnListbox class/Get Clicked Column Header method|Get Clicked Column Header]]
| Get the column number for which the user clicked the column header. The first column on the left is numbered zero. A value of -2 means that no column header has been clicked. After this function reads the value, it changes the value back to -2.
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416912386 |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.
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416912387 |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.
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416912388 |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.
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416912389 |18D99405
| [[MulticolumnListbox class/Custom Item Symbols.Set To Custom Symbol method|Custom Item Symbols:Set To Custom Symbol]]
| Sets the image of an item symbol.
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416912390 |18D99406
| [[MulticolumnListbox class/Custom Item Symbols.Set To Custom Symbol Array method|Custom Item Symbols:Set To Custom Symbol Array]]
| Sets the images of all item symbols.
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416912391 |18D99407
| [[MulticolumnListbox class/Custom Item Symbols.Revert To Built In Symbol method|Custom Item Symbols:Revert To Built In Symbol]]
| Resets an item symbol to the default symbol for its index.
| Yes
|- style="background-color:#FFFFCC;"
| data-sort-value=416912392 |18D99408
| [[MulticolumnListbox class/Custom Item Symbols.Revert All To Built In Symbols method|Custom Item Symbols:Revert All To Built In Symbols]]
| Resets all item symbols to the default symbols.
| Yes
|}
</div></div>
 
== Events ==
<span class="mw-customtoggle-eventstable">Show/Hide MulticolumnListbox Events Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-eventstable">
{{VIServerLegend}}
<div style="width: 80%; max-height: 50em; overflow: auto;">
{| class="wikitable sortable"
|+MulticolumnListbox Events Table
! data-sort-type="number"| Code
! Name
! Description
! Type
|- style="background-color:#FFFFCC;"
| data-sort-value=4294967295 |1073741837
| [[MulticolumnListbox class/Double Click event|Double Click]]
| Generated when a user double-clicks a cell in a multicolumn listbox. LabVIEW does not generate this event if the user double-clicks the scrollbars or the border of the listbox.
| Notify
|- style="background-color:#FFFFCC;"
| data-sort-value=4294967295 |1073741880
| [[MulticolumnListbox class/Edit Cell event|Edit Cell]]
| Generated when the user enters new text or changes text in a cell.
| Notify
|- style="background-color:#FFFFCC;"
| data-sort-value=4294967295 |2147483703
| [[MulticolumnListbox class/Edit Cell? event|Edit Cell?]]
| Generated when the user enters new text or changes text in a cell but before the new or changed text appears.
| Filter
|}
</div></div>
 


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
! Change(s)
! Change(s)
|-
|-
|[[File:LV2018.png|frameless|border|64x64px|LabVIEW 2018|link=LabVIEW 2018]]
|[[File:LV2020.png|frameless|border|64x64px|LabVIEW 2020|link=LabVIEW 2020]]
|More info to come.
| In [[LabVIEW 2020]] the following changes were made:
* The [[MulticolumnListbox class/Selected Cell property|Selected Cell property]] was changed from [[VI Server#Private|Private]] to [[VI Server#Basic Development Environment|Basic Development Environment]]
* The [[MulticolumnListbox class/Bulk Cells.Background Color property|Bulk Cells:Background Color property]] name was changed to [[MulticolumnListbox class/Bulk Cells.Background Colors property|Bulk Cells:Background Colors property]] and was changed from [[VI Server#Private|Private]] to [[VI Server#Basic Development Environment|Basic Development Environment]]
* The [[MulticolumnListbox class/Bulk Cells.Font Color property|Bulk Cells:Font Color property]] name was changed to [[MulticolumnListbox class/Bulk Cells.Font Colors property|Bulk Cells:Font Colors property]] and was changed from [[VI Server#Private|Private]] to [[VI Server#Basic Development Environment|Basic Development Environment]].
|}
|}


Line 24: Line 499:
*[[VI Server]]
*[[VI Server]]
*[[VI Scripting]]
*[[VI Scripting]]


[[Category:VI Server Class]]
[[Category:VI Server Class]]

Latest revision as of 03:57, 17 June 2020

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
    18D99000 Item Names The strings for the selectable items in a two-dimensional array for rows and columns. Read/Write Yes
    18D99001 Item Symbols Array of item symbols. Item symbols (0-40) are as shown in the listbox symbol ring constant. Read/Write Yes
    18D99002 Disabled Items Array of indexes of disabled rows (first row is 0). Read/Write Yes
    18D99005 Column Header Strings[] An array of the strings in the column headers. Read/Write Yes
    18D99006 Visible Items:Symbols Visible If TRUE, displays the item symbols. Read/Write Yes
    18D99007 Visible Items:Vertical Scrollbar Visible If TRUE, displays the vertical scroll bar. Read/Write Yes
    18D99008 Visible Items:Horizontal Scrollbar Visible If TRUE, displays the horizontal scroll bar. Read/Write Yes
    18D99009 Number of Rows Number of visible rows in the multicolumn listbox, excluding column headers. This property counts partially visible rows. Read/Write Yes
    18D9900A Number of Columns Number of visible columns in the multicolumn listbox. This property counts partially visible columns. Read/Write Yes
    18D9900B Visible Items:Column Headers Visible If TRUE, displays the column headers. Read/Write Yes
    18D9900C Top Left Visible Cell The row and column of the item string displayed in the top left corner of the listbox. Use this property to read or change the top item, or use it to read or change the leftmost column of information displayed. Read/Write Yes
    18D9900D Selection Mode Number of items the user can select. Valid values include 0 (zero or one), 1 (one), 2 (zero or more), and 3 (one or more). Read/Write Yes
    18D9900E Active Cell:Active Cell Sets the row and column of the active cell(s). Read/Write Yes
    18D9900F Active Cell:Cell Foreground Color Read/Write Yes
    18D99010 Active Cell:Cell Background Color The background color of the active cell(s). Read/Write Yes
    18D99011 Active Cell:Cell Size The size of the active cell(s) in pixels. Read/Write Yes
    18D99012 Active Cell:Cell Size:Width The width of the active cell(s) in pixels. Read/Write Yes
    18D99013 Active Cell:Cell Size:Height The height of the active cell(s) in pixels. Read/Write Yes
    18D99014 Selection Color The color used to highlight the selected items. Read/Write Yes
    18D99015 Autosizing Row Height Determines whether the rows autosize their height to display all text when fonts change or when the number of lines in a cell changes. Read/Write Yes
    18D99016 Smooth Horizontal Scrolling If TRUE, the horizontal scrolling of the listbox is by pixels, such that the first column may be horizontally clipped. If FALSE, the listbox scrolls by whole column widths such that the first column is never clipped. However, if a column is wider than the width of the listbox, you cannot see the text that is hidden off the right edge of that column. Read/Write Yes
    18D99017 Multiple Line Input If TRUE, you can enter multiple lines of text in the listbox cells by pressing the <Enter> key on the keyboard. If FALSE, pressing the <Enter> key on the keyboard while editing cells causes LabVIEW to commit the edits in the current cell and move the text focus to the next cell. This property does not affect run-time behavior of the listbox. Read/Write Yes
    18D99018 Selected Cell Reads or writes the row and column of the most recently selected cell in the multicolumn listbox. Read/Write Yes
    18D99019 Size The width and height in pixels of the multicolumn listbox control. Read/Write Yes
    18D9901A Size:Width The width of the active cell(s) in pixels. Read/Write Yes
    18D9901B Size:Height The height of the active cell(s) in pixels. Read/Write Yes
    18D9901C Content Rect Position The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the content rectangle of the multicolumn listbox control. Read Only Yes
    18D9901D Content Rect Position:Left The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the content rectangle of the multicolumn listbox control. Read Only Yes
    18D9901E Content Rect Position:Top The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the content rectangle of the multicolumn listbox control. Read Only Yes
    18D9901F Content Rect Bounds The size in pixels of the content rectangle of the multicolumn listbox control. Read Only Yes
    18D99020 Content Rect Bounds:Width The width in pixels of the content rectangle of the multicolumn listbox control. Read Only Yes
    18D99021 Content Rect Bounds:Height The height in pixels of the content rectangle of the multicolumn listbox control. Read Only Yes
    18D99022 Active Cell:Position The coordinate in pixels, relative to the origin of the owning pane, of the top-left position of the active cell(s). Read Only Yes
    18D99023 Active Cell:Position:Left The coordinate in pixels, relative to the origin of the owning pane, of the left edge of the active cell. Read Only Yes
    18D99024 Active Cell:Position:Top The coordinate in pixels, relative to the origin of the owning pane, of the top edge of the active cell. Read Only Yes
    18D99025 Active Cell:Cell Font The font of the active cell in the multicolumn listbox control. Read/Write Yes
    18D99026 Active Cell:Cell Font:Name The name of the font in the active cell. Predefined font names include App Font, Sys Font, and Dlg Font. Read/Write Yes
    18D99027 Active Cell:Cell Font:Size The size of the font in the active cell. Read/Write Yes
    18D99028 Active Cell:Cell Font:Bold Indicates whether the text in the active cell is bold. Read/Write Yes
    18D99029 Active Cell:Cell Font:Italic Indicates whether the text in the active cell is italic. Read/Write Yes
    18D9902A Active Cell:Cell Font:Underline Indicates whether the text in the active cell is underlined. Read/Write Yes
    18D9902B Active Cell:Cell Font:Strikeout Indicates whether to strike out the text in the active cell. Read/Write Yes
    18D9902C Active Cell:Cell Font:Color The text font color in the active cell. Read/Write Yes
    18D9902D Active Cell:Cell Justification Gets and sets the justification of text within a table cell. Read/Write Yes
    18D9902E Drag/Drop:Allow Dragging (Deprecated) Read/Write Yes
    18D9902F Allow Editing Cells If TRUE, users can edit non-header cells in the multicolumn listbox at run time by clicking the cell text in a selected listbox item. If FALSE, users cannot edit non-header cells. Read/Write Yes
    18D99030 Old Edit Position Read/Write Yes
    18D99031 Visible Items:Row Headers Visible Shows the row headers. Read/Write Yes
    18D99032 Row Header Strings[] An array of the strings in the row headers. Read/Write Yes
    18D99033 Is Array? Returns TRUE if the listbox has an array data type. Read/Write Yes
    18D99034 Keyboard Mode Sets how to handle upper and lowercase characters when you type characters in a multicolumn listbox at run time. Valid values include 0 (System Default), 1 (Case Sensitive), and 2 (Case Insensitive). Read/Write Yes
    18D99035 Visible Items:Vertical Lines Visible If TRUE, displays vertical lines that separate columns in the multicolumn listbox. Read/Write Yes
    18D99036 Visible Items:Horizontal Lines Visible If TRUE, displays horizontal lines that separate rows in the multicolumn listbox. Read/Write Yes
    18D99037 Drag/Drop:Allow Dragging If TRUE, LabVIEW automatically begins a drag and drop operation from the control when you use the Operating tool to select and drag an item from the control. Read/Write Yes
    18D99038 Drag/Drop:Allow Dropping If TRUE, LabVIEW automatically accepts drops containing the LV_LISTBOX, LV_TEXT, or LV_LISTBOX_ITEMS data types. The LV_LISTBOX data type is a cluster of the array of strings from the row that you drag data, and a numeric indicating the glyph associated with the row from which you drag. The LV_TEXT data type is of type string. The LV_LISTBOX_ITEMS data type is an array of a cluster containing an array of strings, from left to right, in the item you are dragging and an integer representing the glyph index associated with the item from which you are dragging data. Read/Write Yes
    18D99039 Drag/Drop:Drag Mode Sets the default behavior for a drag and drop operation for the control. The settings apply only when the control configured is the source of the drag and drop operation. Read/Write Yes
    18D9903A Drag/Drop:Allow Drag and Drop Outside Control If TRUE, this enables the control to drag items to other controls and accept drags from other controls. Read/Write Yes
    18D9903B Select Entire Rows Highlights the entire row if you select a row in the tree. Read/Write Yes
    18D9903C Edit Position The row-column pair index of the current text entry. Values of (0,0) indicate the top-left text entry. A value of -1 indicates the row or column header. Values of (-2, -2) indicate that no edits are being made to the text of the control. Read/Write Yes
    18D9903D Focus Row The focus row, used as the basis for key navigation such as the up and down arrows. Read/Write Yes
    18D9903E Bulk Cells:Background Colors Writes the background colors for a group of cells in the multicolumn listbox. Write Only Yes
    18D9903F Bulk Cells:Font Colors Writes the font colors for a group of cells in the multicolumn listbox. Write Only Yes

    Methods

    Show/Hide MulticolumnListbox Methods Table

    Legend
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    MulticolumnListbox Methods Table
    Property ID Long Name (English) Description RTE
    18D99400 Get Double-Clicked Row Gets the row number the user double-clicked. The first row on the top is numbered zero. A value of -2 means that no row has been double-clicked. After this method reads the value, it changes the value back to -2. This method does not respond to a double-click on the header. Yes
    18D99401 Get Clicked Column Header Get the column number for which the user clicked the column header. The first column on the left is numbered zero. A value of -2 means that no column header has been clicked. After this function reads the value, it changes the value back to -2. Yes
    18D99402 Point to Row Column Converts a pixel coordinate to a row-column pair in the coordinates of the control. This method also returns whether the point is inside the bounds of the content rectangle and whether the point is within the custom symbol of the cell. Yes
    18D99403 Custom Item Symbols:Get Symbol Returns the item symbol as a cluster of image data so you can draw it as a picture using the Draw Flattened Pixmap VI or save the image to a file using the Graphics Formats VIs. Yes
    18D99404 Custom Item Symbols:Get Symbol Array Returns the item symbols as an array of clusters of image data so you can draw them as pictures using the Draw Flattened Pixmap VI or save the images to files using the Graphics Formats VIs. Yes
    18D99405 Custom Item Symbols:Set To Custom Symbol Sets the image of an item symbol. Yes
    18D99406 Custom Item Symbols:Set To Custom Symbol Array Sets the images of all item symbols. Yes
    18D99407 Custom Item Symbols:Revert To Built In Symbol Resets an item symbol to the default symbol for its index. Yes
    18D99408 Custom Item Symbols:Revert All To Built In Symbols Resets all item symbols to the default symbols. Yes

    Events

    Show/Hide MulticolumnListbox Events Table

    Legend
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    MulticolumnListbox Events Table
    Code Name Description Type
    1073741837 Double Click Generated when a user double-clicks a cell in a multicolumn listbox. LabVIEW does not generate this event if the user double-clicks the scrollbars or the border of the listbox. Notify
    1073741880 Edit Cell Generated when the user enters new text or changes text in a cell. Notify
    2147483703 Edit Cell? Generated when the user enters new text or changes text in a cell but before the new or changed text appears. Filter


    History

    Version Change(s)
    LabVIEW 2020 In LabVIEW 2020 the following changes were made:

    See Also

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