Labelclass

protected void CaretSantity()PROTECTED

Ensure the text caret and selection are in sane positions, that is, not outside of the text bounds.

public void ClearStyleSpans()PUBLIC

Removes all style spans, retaining the buffer for reuse. Does not change text or selection.

public virtual void FinalLayout(Vector2 offset)PUBLICVIRTUAL

public Sandbox.Rect GetCaretRect(int i)PUBLIC

public int GetCharacterAtScreenPosition(Vector2 pos)PUBLIC

Returns the text element under a screen position, or -1 outside the text. Unlike caret hit testing, both halves of a character return the same index.

public virtual string GetClipboardValue(bool cut)PUBLICVIRTUAL

public int GetLetterAt(Vector2 pos)PUBLIC

public int GetLetterAtScreenPosition(Vector2 pos)PUBLIC

public string GetSelectedText()PUBLIC

Returns the selected text.

public System.Collections.Generic.List`1<int> GetWordBoundaryIndices()PUBLIC

Returns a list of positions in the text of each side of each word within the `Sandbox.UI.Label.Text`. This is used for Control + Arrow Key navigation.

public bool HasSelection()PUBLIC

public void InsertText(string text, int pos, System.Nullable`1<int> endpos = null)PUBLIC

public virtual void LanguageChanged()PUBLICVIRTUAL

When the language changes, if we're token based we need to update to the new phrase.

public void MoveCaretLine(int offset_line, bool select)PUBLIC

Move the text caret to next or previous line.

public void MoveCaretPos(int delta, bool select = False)PUBLIC

Move the text caret by given amount.

public void MoveToLineEnd(bool select = False)PUBLIC

Move the text caret to the end of the current line.

public void MoveToLineStart(bool select = False)PUBLIC

Move the text caret to the start of the current line.

public void MoveToWordBoundaryLeft(bool select)PUBLIC

Move the text caret to the closest word start or end to the left of current position. This simulates holding Control key while pressing left arrow key.

public void MoveToWordBoundaryRight(bool select)PUBLIC

Move the text caret to the closest word start or end to the right of current position. This simulates holding Control key while pressing right arrow key.

protected virtual void OnClick(Sandbox.UI.MousePanelEvent e)PROTECTEDVIRTUAL

public virtual void OnDeleted()PUBLICVIRTUAL

public virtual void OnDraw(Sandbox.Painter painter)PUBLICVIRTUAL

protected virtual void OnMouseMove(Sandbox.UI.MousePanelEvent e)PROTECTEDVIRTUAL

public virtual void RemoveText(int start, int count)PUBLICVIRTUAL

Remove given amount of characters from the label at given `start` position.

public void ReplaceSelection(string str)PUBLIC

Replace the currently selected text with given text. The caret ends up after the replacement.

public void ScrollToCaret()PUBLIC

Put the caret within the visible region.

public void SelectWord(int wordPos)PUBLIC

Select a work at given word position.

public void SetCaretPosition(int pos, bool select = False)PUBLIC

Set the text caret position to the given index.

public virtual void SetContent(string value)PUBLICVIRTUAL

public virtual void SetProperty(string name, string value)PUBLICVIRTUAL

public void SetSelection(int start, int end)PUBLIC

Sets the text selection, preserving its anchor and direction.

public void SetStyleSpan(int start, int end, Sandbox.UI.Styles style)PUBLIC

Styles a range of displayed plain text. Start is inclusive and end is exclusive, in UTF-16 units after whitespace normalization and text-transform. Supply spans in order without overlaps. Supported properties match rich text: font, color, background, spacing and text decorations. Reuse styles between spans; after changing a style, clear and resubmit the spans. Spans are cleared when Text changes, and are not used for HTML or inline paragraphs.

public int Sandbox.UI.Label.CaretPosition { get; set; }PUBLICGETSET

Position of the text cursor/caret within the text, at which newly typed characters are inserted. Setting it keeps it inside the text and scrolls to put it on screen - everything that moves the caret goes through here, so nothing has to remember to do either.

public bool Sandbox.UI.Label.IsRich { get; set; }PUBLICGETSET

Set to true if this is rich text. This means it can support some inline html elements.

public bool Sandbox.UI.Label.Multiline { get; set; }PUBLICGETSET

Enables multi-line support for editing purposes.

public System.Action`1<Sandbox.Html.INode> Sandbox.UI.Label.OnNodeClicked { get; set; }PUBLICGETSET

Called when a node within rich text (`Sandbox.UI.Label.IsRich`) is clicked, with the clicked node. When set, this replaces the default behaviour - which opens a valid http/https `href` on an anchor in the user's browser - letting you inspect the node and handle custom anchor schemes or open in-game popups.

public bool Sandbox.UI.Label.Selectable { get; set; }PUBLICGETSET

Can be selected

public Color Sandbox.UI.Label.SelectionColor { get; set; }PUBLICGETSET

The color used for text selection highlight

public int Sandbox.UI.Label.SelectionEnd { get; set; }PUBLICGETSET

public int Sandbox.UI.Label.SelectionStart { get; set; }PUBLICGETSET

public bool Sandbox.UI.Label.ShouldDrawSelection { get; set; }PUBLICGETSET

public virtual string Sandbox.UI.Label.Text { get; set; }PUBLICVIRTUALGETSET

Text to display on the label.

public int Sandbox.UI.Label.TextLength { get; set; }PUBLICGETSET

Amount of characters in the text of the text entry. Not bytes.

public bool Sandbox.UI.Label.Tokenize { get; set; }PUBLICGETSET

If true and the text starts with #, it will be treated as a language token.