TextField

BarItemReferences
public sealed class TextField : BarItem
A text box on a toolbar.

Constructors

TextField

#
public TextField(IIcon icon, Nomen nomen, string initial)
Create a new toolbar text field.
Parameters:
icon (IIcon)
nomen (Nomen)
initial (string)

Properties

Active

#
public bool Active { get; set; }
Gets or sets whether this text field is active.

AdjacentOnLeftSide

#
public override bool AdjacentOnLeftSide { get; }
Overrides: BarItem.AdjacentOnLeftSide

AdjacentOnRightSide

#
public override bool AdjacentOnRightSide { get; }
Overrides: BarItem.AdjacentOnRightSide

Bar

public Bar Bar { get; }
Gets the toolbar this element is hosted on. This field may be null, but will be assigned by the Bar itself once this element is added to it.
inherited fromBarItem

Bounds

public Rectangle Bounds { get; }
Gets the visible bounds for this element. These bounds are set by the BarItem.Bar during layout.
inherited fromBarItem

Enabled

public bool Enabled { get; set; }
Gets or sets whether this element is enabled. Note that if the parent toolbar is disabled, this element is disabled by implication. Thus, use the BarItem.IsEnabled() function to determine the real state.
inherited fromBarItem

EnterPressed

#
public Action EnterPressed { get; set; }

EscapePressed

#
public Action EscapePressed { get; set; }

Icon

public IIcon Icon { get; }
Gets the icon, if any, associated with this element.
inherited fromBarItem

KeyCode

public BarShortcut KeyCode { get; set; }
Gets or sets the shortcut key for this element. Whether or not this is actually used depends on the form hosting this toolbar.
inherited fromBarItem

MaximumWidth

public int MaximumWidth { get; }
Gets the maximum width (in logical pixels) for this element.
inherited fromBarItem

MinimumWidth

public int MinimumWidth { get; }
Gets the minimum width (in logical pixels) for this element.
inherited fromBarItem

Nomen

public Nomen Nomen { get; }
Gets the nomen describing this element.
inherited fromBarItem

OffColour

public Color? OffColour { get; set; }
Gets or sets the colour associated with the Off state, whenever meaningful.
inherited fromBarItem

OnColour

public Color? OnColour { get; set; }
Gets or sets the colour associated with the On state, whenever meaningful.
inherited fromBarItem

Optional

#
public bool Optional { get; }
Gets or sets whether this textfield is optional. I.e. whether the user can toggle the Active state.

Placeholder

#
public string Placeholder { get; set; }
Gets or sets the placeholder text.

Prefix

#
public string Prefix { get; set; }
Gets or sets a label drawn against the left edge of the field, faded, outside the editable text. Unlike the Suffix - which belongs to the value and travels with it - a prefix holds still, which is what makes it usable as a caption ("min", "max") in place of a separate label on the panel.

Suffix

#
public string Suffix { get; set; }
Optional annotation drawn immediately after the text in a faded version of the text colour, typically a unit, i.e. " seconds". Include the leading space for breathing room.

This is decoration, not content: it is never typed into, selected, measured for the caret, or handed to Validator. It says what the value means, and it is not drawn at all while the Placeholder is showing.

Text

#
public Prose.TextWithCaret Text { get; }

Validator

#
public Func<string, bool> Validator { get; set; }
Optional validity test for the current text. When set and the (non-empty) text fails it, the field is drawn in a warning colour. Purely visual — it does not block typing; callers decide separately whether to act on the value.

Methods

ClearSquiggle

#
public void ClearSquiggle()
Remove the squiggle previously set by SetSquiggle(MessageLevel, string, string).

CreateOutline

protected GraphicsPath CreateOutline()
inherited fromBarItem

CreateOutline

protected GraphicsPath CreateOutline(bool roundedOnLeft, bool roundedOnRight)
Create a new graphics path representing the outline of this item.
inherited fromBarItem
Parameters:
roundedOnLeft (bool)True if path ought to have rounded corners on the left.
roundedOnRight (bool)True if the path ought to have rounded corners on the right.

Draw

public void Draw(Context context)
inherited fromBarItem
Parameters:
context (Context)

DrawDisabled

#
protected override void DrawDisabled(Context context)
Parameters:
context (Context)
Overrides: BarItem.DrawDisabled

DrawFocus

#
protected override void DrawFocus(Context context)
Parameters:
context (Context)
Overrides: BarItem.DrawFocus

DrawHover

#
protected override void DrawHover(Context context)
Parameters:
context (Context)
Overrides: BarItem.DrawHover

DrawIcon

protected bool DrawIcon(Context context, IIcon icon, Rectangle frame, Color background)
Draw the icon (if any) into the given frame. An automatical 2-pixel paddding is created inside the frame.
inherited fromBarItem
Parameters:
context (Context)
icon (IIcon)
frame (Rectangle)
background (Color)
Returns: True if an icon was drawn.

DrawIcon

protected bool DrawIcon(Context context, Rectangle frame, Color background)
Draw the icon (if any) into the given frame. An automatical 2-pixel paddding is created inside the frame.
inherited fromBarItem
Parameters:
context (Context)
frame (Rectangle)
background (Color)
Returns: True if an icon was drawn.

DrawIconAndText

protected bool DrawIconAndText(Context context, IconTextStyle style, string text, Color background)
inherited fromBarItem
Parameters:
context (Context)
style (IconTextStyle)
text (string)
background (Color)

DrawNormal

#
protected override void DrawNormal(Context context)
Parameters:
context (Context)
Overrides: BarItem.DrawNormal

DrawText

protected bool DrawText(Context context, Rectangle frame, string text, Color background)
Draw a string into the frame.
inherited fromBarItem
Parameters:
context (Context)
frame (Rectangle)
text (string)
background (Color)

FindGroupByChapter<T>

protected T[] FindGroupByChapter<T>()
Collect all toolbar elements which share the same nomen chapter as this element. If there is only a single element (i.e. this one) then an empty array is returned.
inherited fromBarItem

FindGroupBySection<T>

protected T[] FindGroupBySection<T>()
Collect all toolbar elements which share the same nomen section as this element, across every bar in the same Bar.Bundle. If there is only a single element (i.e. this one) then an empty array is returned.
inherited fromBarItem

HasNeighbourToTheLeft

protected bool HasNeighbourToTheLeft()
Gets whether the item directly to the left of this item has an outline shape adjacent to this item.
inherited fromBarItem

HasNeighbourToTheRight

protected bool HasNeighbourToTheRight()
Gets whether the item directly to the right of this item has an outline shape adjacent to this item.
inherited fromBarItem

IsEnabled

public bool IsEnabled()
Gets whether both this element and the bar it belongs to are enabled.
inherited fromBarItem

KeyDown

#
public override Response KeyDown(KeyEventArgs e)
Parameters:
e (KeyEventArgs)
Overrides: BarItem.KeyDown

KeyUp

public virtual Response KeyUp(KeyEventArgs e)
inherited fromBarItem
Parameters:
e (KeyEventArgs)

Layout

#
protected override void Layout()
Overrides: BarItem.Layout

MakeOptional

#
public void MakeOptional(string tooltipTitle, string tooltipMessage)
Parameters:
tooltipTitle (string)
tooltipMessage (string)

MouseDoubleClick

#
public override Response MouseDoubleClick(MouseEventArgs e)
Parameters:
e (MouseEventArgs)
Overrides: BarItem.MouseDoubleClick

MouseDown

#
public override Response MouseDown(MouseEventArgs e)
Parameters:
e (MouseEventArgs)
Overrides: BarItem.MouseDown

MouseLeave

#
public override Response MouseLeave(MouseEventArgs e)
Parameters:
e (MouseEventArgs)
Overrides: BarItem.MouseLeave

MouseMove

#
public override Response MouseMove(MouseEventArgs e)
Parameters:
e (MouseEventArgs)
Overrides: BarItem.MouseMove

MouseUp

#
public override Response MouseUp(MouseEventArgs e)
Parameters:
e (MouseEventArgs)
Overrides: BarItem.MouseUp

NeighbourToTheLeft

protected BarItem NeighbourToTheLeft(bool skipSpacers = false)
Gets whether this toolbar element has a neighbour directly to its left.
inherited fromBarItem
Parameters:
skipSpacers (bool = false)

NeighbourToTheRight

protected BarItem NeighbourToTheRight(bool skipSpacers = false)
Gets whether this toolbar element has a neighbour directly to its right.
inherited fromBarItem
Parameters:
skipSpacers (bool = false)

OverrideInfo

public void OverrideInfo(string newInfo)
Override the info of the BarItem.Nomen field.
inherited fromBarItem
Parameters:
newInfo (string)New info to assign.

OverrideText

public void OverrideText(string newName)
Override the name of the BarItem.Nomen field.
inherited fromBarItem
Parameters:
newName (string)New name to assign.

SetSizeLimits

public void SetSizeLimits(int minimum, int maximum)
Set the minimum and maximum width limits.
inherited fromBarItem
Parameters:
minimum (int)
maximum (int)

SetSquiggle

#
public void SetSquiggle(MessageLevel level, string caption, string message)
Underline the text with a coloured squiggle and replace the tooltip with an explanation. This flags a problem with the *content* of the field rather than with the field itself, in the manner of a spellchecker.
Parameters:
level (MessageLevel)Severity, which picks the colour of the squiggle.
caption (string)Short description, shown as the tooltip title.
message (string)Long description, shown as the tooltip body.

SetText

#
public void SetText(string text)
Set new text content.
Parameters:
text (string)

ShowTooltipAt

#
public override bool ShowTooltipAt(PointF location)
Parameters:
location (PointF)
Overrides: BarItem.ShowTooltipAt

TextInput

#
public override Response TextInput(TextInputEventArgs e)
Parameters:
e (TextInputEventArgs)
Overrides: BarItem.TextInput

Events

ActiveChanged

#
public event EventHandler<EventArgs> ActiveChanged

TextChanged

#
public event EventHandler<string> TextChanged
Raised whenever the text changes.