Jump to content

MulticolumnListbox class

From LabVIEW Wiki
Revision as of 23:38, 30 August 2019 by Q (talk | contribs) (Started page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name class
Class ID {{{1}}}
Scope
Class Inheritance

This class is a top-level class.

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 Short Name (English) Description R/W RTE
    18D9900E ActiveCell Sets the row and column of the active cell(s).
    Elements:
    Name Description
    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 –2 to select all rows.
    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 –2 to select all columns. Enter –1 to select the column header.

    The following table lists example values for this property.

    Row Column Result
    -2 0 Selects all cells in the first column, including the column header.
    -2 -2 Selects all rows and columns, including column headers.
    -1 0 Selects the header of the first column.
    -1 -2 Selects the headers of all columns
    0 -2 Selects all cells of the first row, including the row header.
    0 -1 Selects the header of the first row.
    		R/W X
    18D99010 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
    18D99025 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
    18D99028 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
    18D9902C CellFontColor The text font color in the active cell.

    This property is an element of the Active Cell:Cell Font property.

    		R/W X
    18D99029 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
    18D99026 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
    18D99027 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
    18D9902B 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
    18D9902A 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
    18D9902D CellJustify Gets and sets the justification of text within a table cell. R/W X
    18D99011 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
    18D99013 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
    18D99012 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
    18D99022 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
    18D99023 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
    18D99024 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
    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.

    This property is similar to the Editable Cells item on the shortcut menu of a multicolumn listbox.

    		R/W X
    18D99015 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
    18D9903E CellBGColors W X
    18D9903F CellFontColors W X
    18D99005 ColHdrs() An array of the strings in the column headers. R/W X
    18D9901F ContentRectBounds The size in pixels of the content rectangle of the multicolumn listbox control. R X
    18D99021 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
    18D99020 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
    18D9901C 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
    18D9901D 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
    18D9901E 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
    18D99002 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
    18D9903A 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
    18D99037 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
    18D99038 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
    18D99039 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
    18D9903C EditPos 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.

    Before you use this property to set text focus on a control, set key focus of the control.

    Elements:
    Name Description
    Row The row of the current text entry. Possible values are 0…n, where n is the total number of rows - 1.
    Column The column of the current text entry. Possible values are 0…m, where m is the total number of columns - 1. Enter –1 to select the column header.
    		R/W X
    18D9903D FocusRow R/W X
    18D99033 IsArray? Returns TRUE if the listbox has an array data type. R/W X
    18D99000 ItemNames The strings for the selectable items in a two-dimensional array for rows and columns. R/W X
    18D99001 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
    18D99034 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
    18D99017 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
    18D9900A 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 Columns option on the Appearance page of the Multicolumn Listbox Properties dialog box.

    		R/W X
    18D99009 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 Rows option on the Appearance page of the Multicolumn Listbox Properties dialog box.

    		R/W X
    18D99032 RowHdrs() An array of the strings in the row headers. R/W X
    18D9903B SelectEntireRows Highlights the entire row if you select a row in the tree. R/W X
    18D99018 SelectedCell R/W X
    18D99014 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
    18D9900D 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
    18D99019 Size The width and height in pixels of the multicolumn listbox control.

    This property is similar to the Size Height and Size Width options on the Appearance page of the Properties dialog box.

    		R/W X
    18D9901B 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
    18D9901A 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
    18D99016 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 Smooth Scrolling item on the shortcut menu of a multicolumn listbox.

    		R/W X
    18D9900C 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.

    Elements:
    Name Description
    Row The row index of the cell displayed in the top left corner of the listbox.
    Column The column index of the cell displayed in the top left corner of the listbox.
    		R/W X
    18D9900B ColHdrVis If TRUE, displays the column headers.

    This property is similar to the Visible Items»Column Headers item on the shortcut menu of a multicolumn listbox and the Show column headers option on the Appearance page of the Properties dialog box.

    		R/W X
    18D99036 HorizontalLinesVis If TRUE, displays horizontal lines that separate rows in the multicolumn listbox.

    This property is similar to the Visible Items»Horizontal Lines item on the shortcut menu of a multicolumn listbox and the Show horizontal lines option on the Appearance page of the Properties dialog box.

    		R/W X
    18D99008 HScrollVis If TRUE, displays the horizontal scroll bar.

    This property is similar to the Visible Items»Horizontal Scrollbar item on the shortcut menu of a multicolumn listbox and the Show horizontal scroll bar option on the Appearance page of the Multicolumn Listbox Properties dialog box.

    		R/W X
    18D99031 RowHdrVis Shows the row headers.

    This property is similar to the Visible Items»Row Headers item on the shortcut menu of a multicolumn listbox control and to the Show row headers option on the Appearance page of the Multicolumn Listbox Properties dialog box.

    		R/W X
    18D99006 SymbolsVis If TRUE, displays the item symbols.

    This property is similar to the Visible Items»Symbols item on the shortcut menu of a multicolumn listbox and the Show symbols option on the Appearance page of the Properties dialog box.

    		R/W X
    18D99035 VerticalLinesVis If TRUE, displays vertical lines that separate columns in the multicolumn listbox.

    This property is similar to the Visible Items»Vertical Lines item on the shortcut menu of a multicolumn listbox and the Show vertical lines option on the Appearance page of the Properties dialog box.

    		R/W X
    18D99007 VScrollVis If TRUE, displays the vertical scroll bar.

    This property is similar to the Visible Items»Vertical Scrollbar item on the shortcut menu of a multicolumn listbox and the Show vertical scroll bar option on the Appearance page of the Multicolumn Listbox Properties dialog box.

    		R/W X

    Methods

    Show/Hide MulticolumnListbox Methods Table

    Legend
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    MulticolumnListbox Methods Table
    Method ID Short Name (English) Description RTE
    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.

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

    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
    18D99408 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
    18D99407 Custom Item Symbols.Revert Symbol Resets an item symbol to the default symbol for its index. X
    18D99405 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 image data cluster before using this method. The image cluster you wire to this method is similar to the image data input of the Write JPEG File, Write PNG File, and Write BMP File VIs.

    		X
    18D99406 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 image data cluster before using this method. The image clusters you wire to this method are similar to the image data input of the Write JPEG File, Write PNG File, and Write BMP File VIs.

    		X
    18D99401 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 –2 means that no column header has been clicked. After this function reads the value, it changes the value back to –2. X
    18D99400 Get DblClk 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. X
    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. X

    Events

    Show/Hide MulticolumnListbox Events Table

    Legend
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    MulticolumnListbox Events Table
    Code Name Type
    1073741837 Double Click Notify
    1073741880 Edit Cell Notify
    2147483703 Edit Cell? Filter

    History

    History information is needed. What changes have occured 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=9009"