Show / Hide Table of Contents

Class MultiTextBox

A multi-control with text boxes for entering multiple values in the same line. Can also be used to draw text boxes in a row/column table.

Inheritance
Object
BaseScreenComponent
Panel
MultiTextBox
Inherited Members
Panel.Components
Panel.EnableBorder
Panel.HasFocusOutlineColor
Panel.LostFocusOutlineColor
Panel.Outline
Panel.Update()
Panel.Draw()
Panel.SetBorderTextures(Texture2D, Texture2D, Texture2D, Texture2D, Texture2D, Texture2D, Texture2D, Texture2D, Texture2D, FilterMode, Nullable<Border<Vector2Int>>)
Panel.GotFocus()
Panel.LostFocus()
Panel.ProcessHotkeySequences(HotkeySequence.KeyModifiers)
BaseScreenComponent.rectRestrictedRenderArea
BaseScreenComponent.restrictedRenderAreaCustomParent
BaseScreenComponent.restrictedRenderAreaCoordinateType
BaseScreenComponent.backgroundTexture
BaseScreenComponent.animatedBackgroundTextures
BaseScreenComponent.backgroundTextureLayout
BaseScreenComponent.OnKeyboardEvent
BaseScreenComponent.OnMouseEnter
BaseScreenComponent.OnMouseLeave
BaseScreenComponent.OnMouseMove
BaseScreenComponent.OnMouseDown
BaseScreenComponent.OnMouseUp
BaseScreenComponent.OnMouseClick
BaseScreenComponent.OnMouseDoubleClick
BaseScreenComponent.OnRightMouseDown
BaseScreenComponent.OnRightMouseUp
BaseScreenComponent.OnRightMouseClick
BaseScreenComponent.OnRightMouseDoubleClick
BaseScreenComponent.OnMiddleMouseDown
BaseScreenComponent.OnMiddleMouseUp
BaseScreenComponent.OnMiddleMouseClick
BaseScreenComponent.OnMiddleMouseDoubleClick
BaseScreenComponent.OnMouseScrollUp
BaseScreenComponent.OnMouseScrollDown
BaseScreenComponent.Enabled
BaseScreenComponent.UseFocus
BaseScreenComponent.OverridesHotkeySequences
BaseScreenComponent.Name
BaseScreenComponent.Tag
BaseScreenComponent.Position
BaseScreenComponent.Size
BaseScreenComponent.RootSize
BaseScreenComponent.Parent
BaseScreenComponent.Rectangle
BaseScreenComponent.HorizontalAlignment
BaseScreenComponent.VerticalAlignment
BaseScreenComponent.RestrictedRenderAreaCoordinateType
BaseScreenComponent.RectRestrictedRenderArea
BaseScreenComponent.RestrictedRenderAreaCustomParent
BaseScreenComponent.UseRestrictedRenderArea
BaseScreenComponent.CustomMousePosition
BaseScreenComponent.MousePosition
BaseScreenComponent.LastMousePosition
BaseScreenComponent.ScaledMousePosition
BaseScreenComponent.BackgroundColor
BaseScreenComponent.MouseOverBackgroundColor
BaseScreenComponent.BackgroundColorTexture
BaseScreenComponent.BackgroundTexture
BaseScreenComponent.BackgroundCroppedRect
BaseScreenComponent.AnimatedBackgroundTextures
BaseScreenComponent.AnimationDelayInSeconds
BaseScreenComponent.BackgroundTextureLayout
BaseScreenComponent.InteriorWidth
BaseScreenComponent.InteriorHeight
BaseScreenComponent.Scale
BaseScreenComponent.AutoSize
BaseScreenComponent.LocalScale
BaseScreenComponent.ToolTip
BaseScreenComponent.ToolTipText
BaseScreenComponent.SuppressToolTip
BaseScreenComponent.MinAutoScale
BaseScreenComponent.MaxAutoScale
BaseScreenComponent.MouseOverComponent
BaseScreenComponent.TopMargin
BaseScreenComponent.BottomMargin
BaseScreenComponent.LeftMargin
BaseScreenComponent.RightMargin
BaseScreenComponent.ScreenToLocal(Vector2)
BaseScreenComponent.ScreenToLocal(Rect)
BaseScreenComponent.TriggerMouseClick()
BaseScreenComponent.KeyboardEvent(Event)
BaseScreenComponent.MouseClick(Vector2)
BaseScreenComponent.RightMouseClick(Vector2)
BaseScreenComponent.MiddleMouseClick(Vector2)
BaseScreenComponent.MouseDoubleClick(Vector2)
BaseScreenComponent.RightMouseDoubleClick(Vector2)
BaseScreenComponent.MiddleMouseDoubleClick(Vector2)
BaseScreenComponent.MouseEnter()
BaseScreenComponent.MouseLeave(BaseScreenComponent)
BaseScreenComponent.MouseMove(Int32, Int32)
BaseScreenComponent.MouseScrollUp()
BaseScreenComponent.MouseScrollDown()
BaseScreenComponent.Dispose()
BaseScreenComponent.SetMargins(Margins, Int32)
BaseScreenComponent.OffsetFrom(BaseScreenComponent, Sides, Int32)
BaseScreenComponent.SetFocus()
BaseScreenComponent.HasFocus()
Namespace: DaggerfallWorkshop.Game.UserInterface
Assembly: Assembly-CSharp.dll
Syntax
public class MultiTextBox : Panel, IDisposable

Constructors

| Improve this Doc View Source

MultiTextBox()

Make a multi-control with text boxes with default settings.

Declaration
public MultiTextBox()
| Improve this Doc View Source

MultiTextBox(Action<TextBox>)

Make a multi-control with text boxes with a callback to init individual textboxes.

Declaration
public MultiTextBox(Action<TextBox> onAddTextBoxCallback)
Parameters
Type Name Description
Action<TextBox> onAddTextBoxCallback

Properties

| Improve this Doc View Source

EnableOutline

Enable outline on all textboxes.

Declaration
public bool EnableOutline { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

HorizontalSpace

Space between textboxes based on total length (range 0-1).

Declaration
public float HorizontalSpace { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

MaxItemsPerRow

Go to next row when this amount is exceeded. Set to -1 to use a single line.

Declaration
public int MaxItemsPerRow { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

OnAddTextBoxCallback

Set properties to all textboxes.

Declaration
public Action<TextBox> OnAddTextBoxCallback { set; }
Property Value
Type Description
Action<TextBox>
| Improve this Doc View Source

Rect

Full rect of control.

Declaration
public Rect Rect { get; set; }
Property Value
Type Description
Rect
| Improve this Doc View Source

TextBoxes

All the texboxes used by this control.

Declaration
public TextBox[] TextBoxes { get; }
Property Value
Type Description
TextBox[]
| Improve this Doc View Source

VerticalSpace

Space between lines based on total height (range 0-1).

Declaration
public float VerticalSpace { get; set; }
Property Value
Type Description
Single

Methods

| Improve this Doc View Source

DoLayout(Int32, Boolean, NumericMode)

Setup a multi-control with empty text boxes.

Declaration
public void DoLayout(int size, bool isNumeric = false, NumericMode numericMode = NumericMode.Natural)
Parameters
Type Name Description
Int32 size

Number of textboxes.

Boolean isNumeric

Accept only numeric chars.

NumericMode numericMode
| Improve this Doc View Source

DoLayout(Int32[])

Setup a multi-control with text boxes for entering multiple int values.

Declaration
public void DoLayout(params int[] defaultValues)
Parameters
Type Name Description
Int32[] defaultValues

Default values in the requested order.

| Improve this Doc View Source

DoLayout(Single[])

Setup a multi-control with text boxes for entering multiple float values.

Declaration
public void DoLayout(params float[] defaultValues)
Parameters
Type Name Description
Single[] defaultValues

Default values in the requested order.

| Improve this Doc View Source

DoLayout(String[])

Setup a multi-control with text boxes for entering multiple strings.

Declaration
public void DoLayout(params string[] defaultText)
Parameters
Type Name Description
String[] defaultText

Default strings in the requested order.

| Improve this Doc View Source

GetFloatTuple(Int32)

Gets result values from a row of size 2.

Declaration
public Tuple<float, float> GetFloatTuple(int row = 0)
Parameters
Type Name Description
Int32 row
Returns
Type Description
Tuple<Single, Single>
| Improve this Doc View Source

GetFloatValue(Int32)

Gets result value at given index.

Declaration
public float GetFloatValue(int index)
Parameters
Type Name Description
Int32 index
Returns
Type Description
Single
| Improve this Doc View Source

GetFloatValue(Int32, Int32)

Gets result value at given layout position.

Declaration
public float GetFloatValue(int row, int column)
Parameters
Type Name Description
Int32 row
Int32 column
Returns
Type Description
Single
| Improve this Doc View Source

GetFloatValues()

Gets all result values in the layout order.

Declaration
public IEnumerable<float> GetFloatValues()
Returns
Type Description
IEnumerable<Single>
| Improve this Doc View Source

GetInput()

Gets all result strings in the layout order.

Declaration
public IEnumerable<string> GetInput()
Returns
Type Description
IEnumerable<String>
| Improve this Doc View Source

GetIntTuple(Int32)

Gets result values from a row of size 2.

Declaration
public Tuple<int, int> GetIntTuple(int row = 0)
Parameters
Type Name Description
Int32 row
Returns
Type Description
Tuple<Int32, Int32>
| Improve this Doc View Source

GetIntValue(Int32)

Gets result value at given index.

Declaration
public int GetIntValue(int index)
Parameters
Type Name Description
Int32 index
Returns
Type Description
Int32
| Improve this Doc View Source

GetIntValue(Int32, Int32)

Gets result value at given layout position.

Declaration
public int GetIntValue(int row, int column)
Parameters
Type Name Description
Int32 row
Int32 column
Returns
Type Description
Int32
| Improve this Doc View Source

GetIntValues()

Gets all result values in the layout order.

Declaration
public IEnumerable<int> GetIntValues()
Returns
Type Description
IEnumerable<Int32>
| Improve this Doc View Source

Make(Rect, Action<MultiTextBox>, Int32, Action<TextBox>)

Helper which makes a multi-control with text boxes using callbacks.

Declaration
public static MultiTextBox Make(Rect rect, Action<MultiTextBox> doLayout, int maxItemsPerRow = -1, Action<TextBox> onAddTextBoxCallback = null)
Parameters
Type Name Description
Rect rect

Full rect of control.

Action<MultiTextBox> doLayout

Call an overload of DoLayout() to set default values and make the layout.

Int32 maxItemsPerRow

Number of colums, or -1 to use a single row.

Action<TextBox> onAddTextBoxCallback

Set properties to all textboxes.

Returns
Type Description
MultiTextBox

A new instance of MultiTextBox

  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX