Class ListView
ListView
View renders a scrollable list of data where each item can be activated to perform an action.
Inheritance
System.Object
ListView
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Assembly: Terminal.Gui.dll
Syntax
public class ListView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Constructors
|
Improve this Doc
View Source
ListView()
Initializes a new instance of
ListView. Set the
Source property to display something.
Declaration
|
Improve this Doc
View Source
ListView(IList)
Initializes a new instance of
ListView that will display the
contents of the object implementing the
System.Collections.IList interface,
with relative positioning.
Declaration
public ListView(IList source)
Parameters
Type |
Name |
Description |
System.Collections.IList |
source |
An System.Collections.IList data source, if the elements are strings or ustrings,
the string is rendered, otherwise the ToString() method is invoked on the result. |
|
Improve this Doc
View Source
ListView(IListDataSource)
Initializes a new instance of
ListView that will display the provided data source, using relative positioning.
Declaration
public ListView(IListDataSource source)
Parameters
Type |
Name |
Description |
IListDataSource |
source |
IListDataSource object that provides a mechanism to render the data.
The number of elements on the collection should not change, if you must change, set
the "Source" property to reset the internal settings of the ListView. |
|
Improve this Doc
View Source
ListView(Rect, IList)
Initializes a new instance of
ListView that will display the contents of the object implementing the
System.Collections.IList interface with an absolute position.
Declaration
public ListView(Rect rect, IList source)
Parameters
Type |
Name |
Description |
Rect |
rect |
Frame for the listview. |
System.Collections.IList |
source |
An IList data source, if the elements of the IList are strings or ustrings,
the string is rendered, otherwise the ToString() method is invoked on the result. |
|
Improve this Doc
View Source
ListView(Rect, IListDataSource)
Initializes a new instance of
ListView with the provided data source and an absolute position
Declaration
public ListView(Rect rect, IListDataSource source)
Parameters
Type |
Name |
Description |
Rect |
rect |
Frame for the listview. |
IListDataSource |
source |
IListDataSource object that provides a mechanism to render the data.
The number of elements on the collection should not change, if you must change,
set the "Source" property to reset the internal settings of the ListView. |
Properties
|
Improve this Doc
View Source
AllowsMarking
Gets or sets whether this
ListView allows items to be marked.
Declaration
public bool AllowsMarking { get; set; }
Property Value
Type |
Description |
System.Boolean |
Set to true to allow marking elements of the list. |
|
Improve this Doc
View Source
AllowsMultipleSelection
If set to true more than one item can be selected. If false selecting
an item will cause all others to be un-selected. The default is false.
Declaration
public bool AllowsMultipleSelection { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
KeystrokeNavigator
Declaration
public CollectionNavigator KeystrokeNavigator { get; }
Property Value
|
Improve this Doc
View Source
LeftItem
Gets or sets the leftmost column that is currently visible (when scrolling horizontally).
Declaration
public int LeftItem { get; set; }
Property Value
Type |
Description |
System.Int32 |
The left position. |
|
Improve this Doc
View Source
Maxlength
Gets the widest item in the list.
Declaration
public int Maxlength { get; }
Property Value
Type |
Description |
System.Int32 |
|
|
Improve this Doc
View Source
SelectedItem
Gets or sets the index of the currently selected item.
Declaration
public int SelectedItem { get; set; }
Property Value
Type |
Description |
System.Int32 |
The selected item. |
|
Improve this Doc
View Source
Source
Declaration
public IListDataSource Source { get; set; }
Property Value
|
Improve this Doc
View Source
TopItem
Gets or sets the item that is displayed at the top of the
ListView.
Declaration
public int TopItem { get; set; }
Property Value
Type |
Description |
System.Int32 |
The top item. |
Methods
|
Improve this Doc
View Source
AllowsAll()
Declaration
public virtual bool AllowsAll()
Returns
Type |
Description |
System.Boolean |
true if unmarking was successful. |
|
Improve this Doc
View Source
EnsureSelectedItemVisible()
Ensures the selected item is always visible on the screen.
Declaration
public void EnsureSelectedItemVisible()
|
Improve this Doc
View Source
MarkUnmarkRow()
Declaration
public virtual bool MarkUnmarkRow()
Returns
Type |
Description |
System.Boolean |
true if the SelectedItem was marked. |
|
Improve this Doc
View Source
MouseEvent(MouseEvent)
Method invoked when a mouse event is generated
Declaration
public override bool MouseEvent(MouseEvent me)
Parameters
Returns
Type |
Description |
System.Boolean |
true , if the event was handled, false otherwise. |
Overrides
|
Improve this Doc
View Source
MoveDown()
Changes the
SelectedItem to the next item in the list,
scrolling the list if needed.
Declaration
public virtual bool MoveDown()
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
MoveEnd()
Changes the
SelectedItem to last item in the list,
scrolling the list if needed.
Declaration
public virtual bool MoveEnd()
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
MoveHome()
Changes the
SelectedItem to the first item in the list,
scrolling the list if needed.
Declaration
public virtual bool MoveHome()
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
MovePageDown()
Changes the
SelectedItem to the item just below the bottom
of the visible list, scrolling if needed.
Declaration
public virtual bool MovePageDown()
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
MovePageUp()
Changes the
SelectedItem to the item at the top of the visible list.
Declaration
public virtual bool MovePageUp()
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
MoveUp()
Changes the
SelectedItem to the previous item in the list,
scrolling the list if needed.
Declaration
public virtual bool MoveUp()
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
OnEnter(View)
Method invoked when a view gets focus.
Declaration
public override bool OnEnter(View view)
Parameters
Type |
Name |
Description |
View |
view |
The view that is losing focus. |
Returns
Type |
Description |
System.Boolean |
true , if the event was handled, false otherwise. |
Overrides
|
Improve this Doc
View Source
OnLeave(View)
Method invoked when a view loses focus.
Declaration
public override bool OnLeave(View view)
Parameters
Type |
Name |
Description |
View |
view |
The view that is getting focus. |
Returns
Type |
Description |
System.Boolean |
true , if the event was handled, false otherwise. |
Overrides
|
Improve this Doc
View Source
OnOpenSelectedItem()
Declaration
public virtual bool OnOpenSelectedItem()
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
OnRowRender(ListViewRowEventArgs)
Virtual method that will invoke the
RowRender.
Declaration
public virtual void OnRowRender(ListViewRowEventArgs rowEventArgs)
Parameters
|
Improve this Doc
View Source
OnSelectedChanged()
Declaration
public virtual bool OnSelectedChanged()
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
PositionCursor()
Positions the cursor in the right position based on the currently focused view in the chain.
Declaration
public override void PositionCursor()
Overrides
|
Improve this Doc
View Source
ProcessKey(KeyEvent)
If the view is focused, gives the view a
chance to process the keystroke.
Declaration
public override bool ProcessKey(KeyEvent kb)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Overrides
|
Improve this Doc
View Source
Redraw(Rect)
Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
Declaration
public override void Redraw(Rect bounds)
Parameters
Type |
Name |
Description |
Rect |
bounds |
The bounds (view-relative region) to redraw. |
Overrides
|
Improve this Doc
View Source
Scrolls the view down by items
items.
Declaration
public virtual bool ScrollDown(int items)
Parameters
Type |
Name |
Description |
System.Int32 |
items |
Number of items to scroll down. |
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
Scrolls the view left.
Declaration
public virtual bool ScrollLeft(int cols)
Parameters
Type |
Name |
Description |
System.Int32 |
cols |
Number of columns to scroll left. |
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
Scrolls the view right.
Declaration
public virtual bool ScrollRight(int cols)
Parameters
Type |
Name |
Description |
System.Int32 |
cols |
Number of columns to scroll right. |
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
Scrolls the view up by items
items.
Declaration
public virtual bool ScrollUp(int items)
Parameters
Type |
Name |
Description |
System.Int32 |
items |
Number of items to scroll up. |
Returns
Type |
Description |
System.Boolean |
|
|
Improve this Doc
View Source
SetSource(IList)
Sets the source of the
ListView to an
System.Collections.IList.
Declaration
public void SetSource(IList source)
Parameters
Type |
Name |
Description |
System.Collections.IList |
source |
|
|
Improve this Doc
View Source
SetSourceAsync(IList)
Sets the source to an System.Collections.IList value asynchronously.
Declaration
public Task SetSourceAsync(IList source)
Parameters
Type |
Name |
Description |
System.Collections.IList |
source |
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
An item implementing the IList interface. |
Events
|
Improve this Doc
View Source
OpenSelectedItem
This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item.
Declaration
public event Action<ListViewItemEventArgs> OpenSelectedItem
Event Type
|
Improve this Doc
View Source
RowRender
This event is invoked when this
ListView is being drawn before rendering.
Declaration
public event Action<ListViewRowEventArgs> RowRender
Event Type
|
Improve this Doc
View Source
SelectedItemChanged
This event is raised when the selected item in the
ListView has changed.
Declaration
public event Action<ListViewItemEventArgs> SelectedItemChanged
Event Type
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize