family_starAbout
newspaperBlog
published_with_changesChanges
gamesGames
business_centerWorkshop
sprintDashboard
sprintGame Charts
delivery_truck_speedMap Charts
forumForum
docsDocs
docsDocumentation
dashboardApi Reference

Constructors

functionsTextEntry

Fields

lockTimeSinceNotInFocus

Properties

data_objectAcceptsImeInput
data_objectAllowEmojiReplace
data_objectAutoComplete
data_objectCaretPosition
data_objectCharacterRegex
data_objectDisabled
data_objectHasClearButton
data_objectHasContent
data_objectHasValidationErrors
data_objectHistoryCookie
data_objectHistoryMaxItems
data_objectIcon
data_objectIconPanel
lockLabel
data_objectMaxLength
data_objectMaxValue
data_objectMinLength
data_objectMinValue
data_objectMultiline
data_objectNumberFormat
data_objectNumeric
data_objectOnTextEdited
data_objectPlaceholder
data_objectPrefix
data_objectPrefixLabel
data_objectSelectionColor
data_objectStringRegex
data_objectSuffix
data_objectSuffixLabel
data_objectText
data_objectTextLength
data_objectValue

Methods

functionsAddToHistory
lockAutoCompleteCancel
lockAutoCompleteSelectionChanged
functionsCanEnterCharacter
functionsClearHistory
functionsDestroyAutoComplete
functionsDrawContent
functionsFixNumeric
functionsGetClipboardValue
lockIsPanelEmpty
lockOnBlur
functionsOnButtonEvent
functionsOnButtonTyped
lockOnDoubleClick
lockOnDragSelect
lockOnEvent
lockOnFocus
functionsOnKeyTyped
lockOnMouseDown
lockOnMouseMove
lockOnMouseUp
functionsOnPaste
functionsOnValueChanged
functionsSetProperty
functionsTick
functionsUpdateAutoComplete
functionsUpdateValidation
menu
Api
Classes
TextEntry
TextEntry
Sandbox.UI.TextEntry   account_tree Derives from BaseControl
classAssembly: Base Library

Inheritence

Panel
BaseControl
TextEntry
NumberEntry

Summary

A UI.Panel that the user can enter text into.

Constructors

TextEntry

Fields

TimeSinceNotInFocus Keep tabs of when we were focused so we can flash the caret relative to that time. We want the caret to be visible immediately on focus

Properties

AcceptsImeInput Allow IME input when this is focused.
AllowEmojiReplace Whether to allow automatic replacement of emoji codes with their actual unicode emoji characters. See Sandbox.UI.Emoji.
AutoComplete If you hook a method up here we'll do autocomplete on it. Return a list if strings for given string input.
CaretPosition
CharacterRegex If set, will block the input of any character that doesn't match. Will also set Sandbox.UI.TextEntry.HasValidationErrors accordingly.
Disabled Is the text entry disabled? If disabled, will add a "disabled" class and prevent focus.
HasClearButton If true then Icon/IconPanel will be set to a clear button that clears the text when clicked.
HasContent
HasValidationErrors If true then this control has validation errors and the input shouldn't be accepted.
HistoryCookie If set, the history of this text entry will be stored and restored using this key in the local Sandbox.Internal.GlobalGameNamespace.Cookie.
HistoryMaxItems Maximum amount of items Sandbox.UI.TextEntry.AddToHistory(System.String) will keep. Oldest items will be discarded as new ones are added.
Icon If set, will display a material icon at the end of the text entry.
IconPanel The Sandbox.UI.IconPanel that displays Sandbox.UI.TextEntry.Icon
Label The Sandbox.UI.TextEntry.Label that contains the text of this text entry.
MaxLength If set, visually signals when the input text is longer than this value. Will also set Sandbox.UI.TextEntry.HasValidationErrors accordingly.
MaxValue If we're numeric, this is the highest numeric value allowed
MinLength If set, visually signals when the input text is shorter than this value. Will also set Sandbox.UI.TextEntry.HasValidationErrors accordingly.
MinValue If we're numeric, this is the lowest numeric value allowed
Multiline Makes it possible to enter new lines into the text entry. (By pressing the Enter key, which no longer acts as the submit key)
NumberFormat Affects formatting of the text when Sandbox.UI.TextEntry.Numeric is enabled. Accepts any format that is supported by System.Single.ToString(System.String). See examples here.
Numeric When set to true, ensures only numeric values can be typed. Also applies Sandbox.UI.TextEntry.FixNumeric on text.
OnTextEdited Called when the text of this text entry is changed.
Placeholder Text to display when the text entry is empty. Typically a very short description of the expected contents or function of the text entry.
Prefix If set, will display given text before the text entry box.
PrefixLabel The Sandbox.UI.TextEntry.Label that shows Sandbox.UI.TextEntry.Prefix text.
SelectionColor The color used for text selection highlight. Defaults to cyan with transparency.
StringRegex If set, Sandbox.UI.TextEntry.HasValidationErrors will return true if doesn't match regex.
Suffix If set, will display given text after the text entry box.
SuffixLabel The Sandbox.UI.TextEntry.Label that shows Sandbox.UI.TextEntry.Suffix text.
Text Access to the raw text in the text entry.
TextLength
Value The value of the text entry. Returns Sandbox.UI.TextEntry.Text, but does special logic when setting text.

Methods

AddToHistory Add given string to the history of this text entry. The history can be accessed by the player by pressing up and down arrows with an empty text entry.
AutoCompleteCancel Auto complete was canceled, restore text to what it was before we started, and remove the auto complete popup.
AutoCompleteSelectionChanged Auto complete selection has changed. Update the text entry text to that selected value.
CanEnterCharacter Called when a character is typed by the player.
ClearHistory Clear the input history that was previously added via Sandbox.UI.TextEntry.AddToHistory(System.String).
DestroyAutoComplete Close and delete the auto complete popup panel.
DrawContent
FixNumeric Called to ensure the Sandbox.UI.TextEntry.Text is absolutely in the correct format, in this case - a valid number format.
GetClipboardValue
IsPanelEmpty The TextEntry has the :empty style when the text is unset
OnBlur
OnButtonEvent
OnButtonTyped
OnDoubleClick
OnDragSelect
OnEvent
OnFocus
OnKeyTyped
OnMouseDown
OnMouseMove
OnMouseUp
OnPaste
OnValueChanged Called when the text entry's value changes.
SetProperty
Tick
UpdateAutoComplete Open the auto complete popup with values from Sandbox.UI.TextEntry.AutoComplete. Close the popup if we have no auto complete entries.
UpdateValidation Update the validation state of this control.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.