TX Text Control .NET for Windows Forms

RibbonListView Class

Class|Introduced in 24.0
Namespace
TXTextControl.Windows.Forms.Ribbon
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Windows.Forms.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.Windows.Forms.dll from the setup.
Inherits
  1. ScrollableControl
  2. RibbonListView
Implements
INotifyPropertyChanged

Description

The RibbonListView class is a list view control, which displays a collection of items that can be displayed using one of three different views. The RibbonListView class is inherited from the System.Windows.Forms.Control class and implements the System.ComponentModel.INotifyPropertyChanged interface. The following describes only the properties, methods and events defined through the RibbonListView class. For a list of properties, methods and events inherited from the System.Windows.Forms.Control class and the System.ComponentModel.INotifyPropertyChanged interface see the .NET Framework reference.

Syntax

public class RibbonListView : ScrollableControl, INotifyPropertyChanged

Examples

The following example creates a Ribbon List View instance and configures its deselectable setting for a document workflow.

using TXTextControl.Windows.Forms.Ribbon.RibbonListView ribbonListView = new();
ribbonListView.Deselectable = true;

Members

Constructors

ConstructorDescription
RibbonListViewInitializes a new instance of the RibbonListView class.

Properties

PropertyDescription
CellPaddingGets or sets the amount of space between the cell's item and the cell's border.
ColumnCountGets the number of columns in this RibbonListView. This value is the larger of the RibbonListView.MinColumnCount property value and the maximum number of columns which can be displayed inside the control.
ColumnWidthGets the width, in 1/96 inch, for each column in this RibbonListView. This value equals to the width of the RibbonListView's broadest RibbonListViewItem plus the horizontal cell padding value.
DefaultBackColorNot described in the reference. public Color DefaultBackColor { get; }
DeselectableGets or sets a value whether a selected RibbonListViewItem can be deselected by clicking into a cell that does not contain a RibbonListViewItem or clicking on it in combination with the pressed Ctrl key.
DropDownItemsGets the collection of controls in the drop-down menu that is associated with this RibbonListView. These controls can be objects of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator.
EditItemTextBoxEmptyWidthGets or sets a value, in 1/96 inch, specifying the width of the edit item text box for an item where no text is set. The default value is 0.
EnabledNot described in the reference. public bool Enabled { get; set; }
HideItemsGets or sets a value indicating whether the RibbonListViewItems are displayed inside the RibbonListView or not. The default value is false.
HideSelectedItemsGets or sets a value indicating whether the selected RibbonListViewItems are highlighted inside the RibbonListView or not. The default value is false.
ItemsSourceGets or sets an array of RibbonListViewItems used to generate the content of this RibbonListView. The default value is null.
KeyTipGets or sets the keyboard shortcut of the RibbonListView.
MaxColumnCountGets or sets a value specifying the maximum number of columns in this RibbonListView. If the value is set to null, the number of columns is the maximum number of columns which can be displayed inside the control. The default value is null.
MaxColumnWidthGets or sets a value, in 1/96 inch, specifying the maximum column width in this RibbonListView. The default value is int.MaxValue.
MaxVisibleRowsGets or sets a value specifying the maximum number of rows that are displayed by the RibbonListView. If the value is set to null, the number of rows is not limited and the RibbonListView's height bounds to the actual number of rows. The default value is null.
MinColumnCountGets or sets the minimum number of columns in this RibbonListView.
MinColumnWidthGets or sets the minimum width, in 1/96 inch, of a column. The default value is 0.
MinimumWidthGets or sets the minimum width, in 1/96 inch, of the RibbonListView. The default value is 0.
MinRowCountGets or sets the minimum number of rows in this RibbonListView.
MultiSelectGets or sets a value indicating whether multiple items can be selected.
ParentCollectionGets the RibbonItemCollection that contains this RibbonListView.
RibbonListViewItemsGets a collection containing all items in this RibbonListView.
RowCountGets the number of rows in this RibbonListView.
RowHeightGets the height, in 1/96 inch, for each row in this RibbonListView. This value equals to the height of the RibbonListView's highest RibbonListViewItem plus the vertical cell padding value.
ScrollButtonsVisibleGets or sets a value whether the scroll bars buttons should be displayed or not. The default value is true.
SelectedIndicesGets or sets the indexes of the selected items in this RibbonListView.
SelectedItemsGets or sets the items that are selected in this RibbonListView.
SelectWithArrowKeysGets or sets a value indicating whether an item is set to selected after choosing it by using arrow keys. If the property is set to false, pressing an arrow key moves the selector to the corresponding item, but does not select the item. The default value is false.
ShowBorderGets or sets a value indicating whether this RibbonListView is surrounded by a border or not. The default value is false.
ShowItemsInDropDownGets or sets a value indicating whether this RibbonListView's drop down menu displays additionally to the drop down items the control's RibbonListViewItems or not. The default value is false.
ToolTipGets an object of type RibbonToolTip that displays text when the mouse pointer hovers over RibbonListView's scroll bar or drop-down button.
ViewModeGets or sets the mode in which this RibbonListView displays its items. All values can be combined with each other. The default value is ListViewMode.Icon.
VisibleNot described in the reference. public bool Visible { get; set; }

Methods

MethodDescription
ActivateEditItemTextBoxDisplays a text box to edit the specified RibbonListViewItem.
DeactivateEditItemTextBoxCloses the text box that is displayed to edit an item.
ScrollToScrolls the contents of the RibbonListView to a specified RibbonListViewItem.

Events

EventDescription
DropDownClosedOccurs as the RibbonListView's drop-down menu is closed.
DropDownOpeningOccurs as the RibbonListView's drop-down menu is opening.
EditItemTextBoxActivatedOccurs when the edit item text box is displayed.
EditItemTextBoxDeactivatedOccurs when the edit item text box is closed.
ItemClickOccurs when an RibbonListViewItem is clicked.
ItemDropDownClosedOccurs as a RibbonListViewItem's drop-down menu is closed.
ItemDropDownOpeningOccurs as a RibbonListViewItem's drop-down menu is opening.
ItemMouseDownOccurs when the mouse pointer is over a RibbonListViewItem and the mouse button is pressed.
ItemMouseEnterOccurs when the mouse pointer enters a RibbonListViewItem.
ItemMouseLeaveOccurs when the mouse pointer leaves a RibbonListViewItem.
ItemMouseUpOccurs when the mouse pointer is over a RibbonListViewItem and the mouse button is released.
PropertyChangedNot described in the reference. public event PropertyChangedEventHandler PropertyChanged;