Space Engineers
Properties | List of all members
Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlListbox Interface Reference

This is a list box. It contains a list of items that a user can select. More...

Inheritance diagram for Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlListbox:
Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTitleTooltip Sandbox.Game.Gui.MyTerminalControlListbox< TBlock >

Properties

bool Multiselect [get, set]
 This allows you to enable/disable multiple item selection More...
 
int VisibleRowsCount [get, set]
 This allows you to set how many rows are visible in the list box. More...
 
Action< IMyTerminalBlock, List< MyTerminalControlListBoxItem >, List< MyTerminalControlListBoxItem > > ListContent [set]
 This is triggered when you need to populate the list with list items. The first list is the items in the list box, and the second list is the selected items in the list. More...
 
Action< IMyTerminalBlock, List< MyTerminalControlListBoxItem > > ItemSelected [set]
 This is triggered when an item is selected. Can contain more than one item if Multiselect is true. More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl
string Id [get]
 Identifier of control More...
 
Func< IMyTerminalBlock, bool > Enabled [set]
 Allows you to set if the control is enabled More...
 
Func< IMyTerminalBlock, bool > Visible [set]
 Allows you to set if the control is visible More...
 
bool SupportsMultipleBlocks [get, set]
 Allows you to set if the control is visible when the block is selected as a group More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTitleTooltip
MyStringId Title [get, set]
 Allows you to get or set the Label that appears on the control More...
 
MyStringId Tooltip [get, set]
 Allows you to get or set the tooltip that appears when you hover over the control More...
 

Additional Inherited Members

- Public Member Functions inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl
void RedrawControl ()
 Recreates the control GUI. This allows you to update the Title of some controls. More...
 
void UpdateVisual ()
 This updates a control that is currently displayed, allowing you to refresh it's state More...
 

Detailed Description

This is a list box. It contains a list of items that a user can select.

Definition at line 11 of file IMyTerminalControlListbox.cs.

Property Documentation

Action<IMyTerminalBlock, List<MyTerminalControlListBoxItem> > Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlListbox.ItemSelected
set

This is triggered when an item is selected. Can contain more than one item if Multiselect is true.

Definition at line 29 of file IMyTerminalControlListbox.cs.

Action<IMyTerminalBlock, List<MyTerminalControlListBoxItem>, List<MyTerminalControlListBoxItem> > Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlListbox.ListContent
set

This is triggered when you need to populate the list with list items. The first list is the items in the list box, and the second list is the selected items in the list.

Definition at line 25 of file IMyTerminalControlListbox.cs.

bool Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlListbox.Multiselect
getset

This allows you to enable/disable multiple item selection

Definition at line 16 of file IMyTerminalControlListbox.cs.

int Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlListbox.VisibleRowsCount
getset

This allows you to set how many rows are visible in the list box.

Definition at line 20 of file IMyTerminalControlListbox.cs.


The documentation for this interface was generated from the following file: