Class ListBox
Implements a text list box.
Assembly: Assembly-CSharp.dll
Syntax
public class ListBox : BaseScreenComponent, IDisposable
Constructors
|
Improve this Doc
View Source
ListBox()
Declaration
Properties
|
Improve this Doc
View Source
List will accept keyboard input even when mouse not over control.
Do not set this when multiple lists are used within same UI, or any other control where inputs might overlap.
Declaration
public bool AlwaysAcceptKeyboardInput { get; set; }
Property Value
|
Improve this Doc
View Source
Count
Declaration
public int Count { get; }
Property Value
|
Improve this Doc
View Source
Enables horizontally scrolling of listbox content (this mode can be used if textlabels do not horizontally fit into listbox entirely)
Declaration
public bool EnabledHorizontalScroll { get; set; }
Property Value
|
Improve this Doc
View Source
Font
Declaration
public DaggerfallFont Font { get; set; }
Property Value
|
Improve this Doc
View Source
Horizontal scroll index - depending on HorizontalScrollMode its unit is either in characters or pixels
Declaration
public int HorizontalScrollIndex { get; set; }
Property Value
|
Improve this Doc
View Source
set horizontal scroll mode to either character wise or pixel wise
Declaration
public ListBox.HorizontalScrollModes HorizontalScrollMode { get; set; }
Property Value
|
Improve this Doc
View Source
ListItems
Declaration
public List<ListBox.ListItem> ListItems { get; }
Property Value
|
Improve this Doc
View Source
MaxCharacters
Maximum length of label string.
Setting to -1 allows for any length.
Declaration
public int MaxCharacters { get; set; }
Property Value
|
Improve this Doc
View Source
Maximal allowed horizontal scroll index - depending on HorizontalScrollMode its unit is either in characters or pixels
Declaration
public int MaxHorizontalScrollIndex { get; set; }
Property Value
|
Improve this Doc
View Source
RowAlignment
Declaration
public HorizontalAlignment RowAlignment { get; set; }
Property Value
|
Improve this Doc
View Source
RowsDisplayed
Declaration
public int RowsDisplayed { get; set; }
Property Value
|
Improve this Doc
View Source
RowSpacing
Declaration
public int RowSpacing { get; set; }
Property Value
|
Improve this Doc
View Source
Declaration
public int ScrollIndex { get; set; }
Property Value
|
Improve this Doc
View Source
SelectedIndex
Declaration
public int SelectedIndex { get; set; }
Property Value
|
Improve this Doc
View Source
SelectedItem
Declaration
public string SelectedItem { get; }
Property Value
|
Improve this Doc
View Source
SelectedShadowColor
Declaration
public Color SelectedShadowColor { get; set; }
Property Value
|
Improve this Doc
View Source
SelectedShadowPosition
Declaration
public Vector2 SelectedShadowPosition { get; set; }
Property Value
|
Improve this Doc
View Source
SelectedTextColor
Declaration
public Color SelectedTextColor { get; set; }
Property Value
|
Improve this Doc
View Source
SelectedValue
Declaration
public ListBox.ListItem SelectedValue { get; }
Property Value
|
Improve this Doc
View Source
ShadowColor
Declaration
public Color ShadowColor { get; set; }
Property Value
|
Improve this Doc
View Source
ShadowPosition
Declaration
public Vector2 ShadowPosition { get; set; }
Property Value
|
Improve this Doc
View Source
TextColor
Declaration
public Color TextColor { get; set; }
Property Value
|
Improve this Doc
View Source
TextScale
Declaration
public float TextScale { get; set; }
Property Value
|
Improve this Doc
View Source
set vertical scroll mode to either character wise or pixel wise
Declaration
public ListBox.VerticalScrollModes VerticalScrollMode { get; set; }
Property Value
|
Improve this Doc
View Source
WrapTextItems
enable wrapping of text items, additional mode for word wrapping can be activated with property WrapWords
Declaration
public bool WrapTextItems { get; set; }
Property Value
|
Improve this Doc
View Source
WrapWords
enable wrapping of words in text items - Property WrapTextItems must be set to true as well so that this has an effect
Declaration
public bool WrapWords { get; set; }
Property Value
Methods
|
Improve this Doc
View Source
AddItem(TextLabel, out ListBox.ListItem, Int32, String)
Declaration
public void AddItem(TextLabel textLabel, out ListBox.ListItem itemOut, int position = -1, string tag = null)
Parameters
|
Improve this Doc
View Source
AddItem(String, out ListBox.ListItem, Int32, Object)
Declaration
public void AddItem(string text, out ListBox.ListItem itemOut, int position = -1, object tag = null)
Parameters
|
Improve this Doc
View Source
AddItem(String, Int32, Object)
Declaration
public void AddItem(string text, int position = -1, object tag = null)
Parameters
|
Improve this Doc
View Source
AddItems(IEnumerable<TextLabel>)
Declaration
public void AddItems(IEnumerable<TextLabel> labels)
Parameters
|
Improve this Doc
View Source
AddItems(IEnumerable<String>)
Declaration
public void AddItems(IEnumerable<string> items)
Parameters
|
Improve this Doc
View Source
ClearItems()
Declaration
|
Improve this Doc
View Source
Draw()
Declaration
public override void Draw()
Overrides
|
Improve this Doc
View Source
FindIndex(String)
Declaration
public int FindIndex(string text)
Parameters
Type |
Name |
Description |
String |
text |
|
Returns
|
Improve this Doc
View Source
GetItem(Int32)
Declaration
public ListBox.ListItem GetItem(int index)
Parameters
Type |
Name |
Description |
Int32 |
index |
|
Returns
|
Improve this Doc
View Source
HeightContent()
Declaration
public int HeightContent()
Returns
|
Improve this Doc
View Source
Declaration
public void HorizontalScrollLeft()
|
Improve this Doc
View Source
Declaration
public void HorizontalScrollRight()
|
Improve this Doc
View Source
LengthOfLongestItem()
Declaration
public int LengthOfLongestItem()
Returns
|
Improve this Doc
View Source
MouseClick(Vector2)
Declaration
protected override void MouseClick(Vector2 clickPosition)
Parameters
Type |
Name |
Description |
Vector2 |
clickPosition |
|
Overrides
|
Improve this Doc
View Source
MouseDoubleClick(Vector2)
Declaration
protected override void MouseDoubleClick(Vector2 clickPosition)
Parameters
Type |
Name |
Description |
Vector2 |
clickPosition |
|
Overrides
|
Improve this Doc
View Source
MouseLeave(BaseScreenComponent)
Declaration
protected override void MouseLeave(BaseScreenComponent sender)
Parameters
Overrides
|
Improve this Doc
View Source
MouseMove(Int32, Int32)
Declaration
protected override void MouseMove(int x, int y)
Parameters
Overrides
|
Improve this Doc
View Source
Declaration
protected override void MouseScrollDown()
Overrides
|
Improve this Doc
View Source
Declaration
protected override void MouseScrollUp()
Overrides
|
Improve this Doc
View Source
RemoveItem(Int32)
Declaration
public void RemoveItem(int index)
Parameters
Type |
Name |
Description |
Int32 |
index |
|
|
Improve this Doc
View Source
Declaration
|
Improve this Doc
View Source
Declaration
public void ScrollToSelected()
|
Improve this Doc
View Source
Declaration
|
Improve this Doc
View Source
SelectIndex(Int32)
Declaration
public void SelectIndex(int index)
Parameters
Type |
Name |
Description |
Int32 |
index |
|
|
Improve this Doc
View Source
SelectNext()
Declaration
|
Improve this Doc
View Source
SelectNone()
Declaration
|
Improve this Doc
View Source
SelectPrevious()
Declaration
public void SelectPrevious()
|
Improve this Doc
View Source
SetRowsDisplayedByHeight()
Declaration
public void SetRowsDisplayedByHeight()
|
Improve this Doc
View Source
SwapItems(Int32, Int32)
Declaration
public void SwapItems(int indexA, int indexB)
Parameters
|
Improve this Doc
View Source
Update()
Declaration
public override void Update()
Overrides
|
Improve this Doc
View Source
UpdateItem(Int32, String)
Declaration
public void UpdateItem(int index, string label)
Parameters
|
Improve this Doc
View Source
UseSelectedItem()
Declaration
public void UseSelectedItem()
|
Improve this Doc
View Source
WidthContent()
Declaration
public int WidthContent()
Returns
Events
|
Improve this Doc
View Source
Declaration
public event ListBox.OnScrollHandler OnScroll
Event Type
|
Improve this Doc
View Source
OnSelectItem
Declaration
public event ListBox.OnSelectItemEventHandler OnSelectItem
Event Type
|
Improve this Doc
View Source
OnSelectNext
Declaration
public event ListBox.OnSelectNextEventHandler OnSelectNext
Event Type
|
Improve this Doc
View Source
OnSelectPrevious
Declaration
public event ListBox.OnSelectPreviousEventHandler OnSelectPrevious
Event Type
|
Improve this Doc
View Source
OnUseSelectedItem
Declaration
public event ListBox.OnUseSelectedItemEventHandler OnUseSelectedItem
Event Type