Xceed Logo
Shop
Xceed Toolkit for .NET Maui v2.0 Documentation
Xceed.Maui.Toolkit Assembly / Xceed.Maui.Toolkit Namespace / TextBox Class
Members Example


In This Topic
    TextBox Class
    In This Topic
    Like Maui Framework's Entry control, the TextBox allows to input text, but is more flexible than said control since, for example, it allows to remove the focus underline, modify the Borders & their CornerRadius, change the style of the Clear button & add more than just text to the Watermark.
    Syntax
    'Declaration
 

    Public Class TextBox 
   Inherits Control
   Implements Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IEffectControlProvider, Microsoft.Maui.Controls.IElementController, Microsoft.Maui.Controls.IGestureRecognizers, Microsoft.Maui.Controls.ILayout, Microsoft.Maui.Controls.ILayoutController, Microsoft.Maui.Controls.Internals.IGestureController, Microsoft.Maui.Controls.IViewController, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.HotReload.IHotReloadableView, Microsoft.Maui.IContentView, Microsoft.Maui.IContextFlyoutElement, Microsoft.Maui.ICrossPlatformLayout, Microsoft.Maui.IElement, Microsoft.Maui.IPadding, Microsoft.Maui.IPropertyMapperView, Microsoft.Maui.IReplaceableView, Microsoft.Maui.IToolTipElement, Microsoft.Maui.ITransform, Microsoft.Maui.IView, Microsoft.Maui.IVisualTreeElement 
    'Usage
 

    Dim instance As TextBox
    public class TextBox : Control, Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IEffectControlProvider, Microsoft.Maui.Controls.IElementController, Microsoft.Maui.Controls.IGestureRecognizers, Microsoft.Maui.Controls.ILayout, Microsoft.Maui.Controls.ILayoutController, Microsoft.Maui.Controls.Internals.IGestureController, Microsoft.Maui.Controls.IViewController, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.HotReload.IHotReloadableView, Microsoft.Maui.IContentView, Microsoft.Maui.IContextFlyoutElement, Microsoft.Maui.ICrossPlatformLayout, Microsoft.Maui.IElement, Microsoft.Maui.IPadding, Microsoft.Maui.IPropertyMapperView, Microsoft.Maui.IReplaceableView, Microsoft.Maui.IToolTipElement, Microsoft.Maui.ITransform, Microsoft.Maui.IView, Microsoft.Maui.IVisualTreeElement
    Example

    The following code will display this control:

    <xctk:TextBox Text="ABC"
              ClearButtonVisibility="WhileEditing"
              WidthRequest="150"
              IsFocusUnderlineVisible="True"
              Watermark="Enter text here..."/>
    Inheritance Hierarchy

    System.Object
       Microsoft.Maui.Controls.BindableObject
          Microsoft.Maui.Controls.Element
             Microsoft.Maui.Controls.NavigableElement
                Microsoft.Maui.Controls.VisualElement
                   Microsoft.Maui.Controls.View
                      Microsoft.Maui.Controls.Compatibility.Layout
                         Microsoft.Maui.Controls.TemplatedView
                            Xceed.Maui.Toolkit.Control
                               Xceed.Maui.Toolkit.TextBox
                                  Xceed.Maui.Toolkit.AutoCompleteTextBox
                                  Xceed.Maui.Toolkit.MaskedTextBox

    Public Constructors
     NameDescription
    Public ConstructorTextBox Constructor  
    Top
    Public Fields
     NameDescription
    Public Fieldstatic (Shared in Visual Basic)CharacterSpacingProperty  
    Public Fieldstatic (Shared in Visual Basic)ClearButtonStyleProperty  
    Public Fieldstatic (Shared in Visual Basic)ClearButtonVisibilityProperty  
    Public Fieldstatic (Shared in Visual Basic)CursorPositionProperty  
    Public Fieldstatic (Shared in Visual Basic)IsFocusedProperty  
    Public Fieldstatic (Shared in Visual Basic)IsFocusUnderlineVisibleProperty  
    Public Fieldstatic (Shared in Visual Basic)IsReadOnlyProperty  
    Public Fieldstatic (Shared in Visual Basic)IsTextPredictionEnabledProperty  
    Public Fieldstatic (Shared in Visual Basic)KeyboardProperty  
    Public Fieldstatic (Shared in Visual Basic)MaxLengthProperty  
    Public Fieldstatic (Shared in Visual Basic)ReturnCommandParameterProperty  
    Public Fieldstatic (Shared in Visual Basic)ReturnCommandProperty  
    Public Fieldstatic (Shared in Visual Basic)SelectionLengthProperty  
    Public Fieldstatic (Shared in Visual Basic)TextProperty  
    Public Fieldstatic (Shared in Visual Basic)WatermarkProperty  
    Top
    Protected Fields
     NameDescription
    Protected FieldpropertyMapper (Inherited from Microsoft.Maui.Controls.View)
    Top
    Public Properties
     NameDescription
    Public PropertyAnchorX (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyAnchorY (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyAutomationId (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyBackgroundGets or sets the Brush that will be used to paint the Control's background. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyBackgroundColor (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyBehaviors (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyBindingContext (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public PropertyBorderBrushGets or sets the Brush that will be used to paint the Control's Border. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyBorderThicknessGets or sets the thickness of this Control's Border. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyBounds (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyCascadeInputTransparent (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public PropertyCharacterSpacingGets or sets the spacing between characters.  
    Public Propertyclass (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public PropertyClassId (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyClearButtonStyleGets or sets the Clear button's Style.  
    Public PropertyClearButtonVisibilityGets or sets if the Clear button is visible or not.  
    Public PropertyClip (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyControlTemplate (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Public PropertyCornerRadiusGets or sets the radius for the 4 corners of this Control.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyCursorPositionGets or sets the position of the cursor when editing Text in the TextBox.  
    Public PropertyDesiredSize (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyDispatcher (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public PropertyEffects (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyFlowDirection (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyFontAttributesGets or sets the FontAttributes that will be applied to the Control's textual Content.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyFontFamilyGets or sets the font family that will be used to display the Control's textual Content.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyFontSizeGets or sets the font size that will determine the scale of the Control's textual Content.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyFrame (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyGestureRecognizers (Inherited from Microsoft.Maui.Controls.View)
    Public PropertyHandler (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyHeight (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyHeightRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyHorizontalContentOptionsGets or sets how the Control's Content is aligned horizontally. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyHorizontalOptions (Inherited from Microsoft.Maui.Controls.View)
    Public PropertyId (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyInputTransparent (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyIsClippedToBounds (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public PropertyIsEnabled (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyIsFocusedGets if the TextBox is currently in focus.  
    Public PropertyIsFocusUnderlineVisibleGets or sets if the underline, which changes color when the TextBox is in focus, is visible or not.  
    Public PropertyIsLoaded (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyIsReadOnlyGets or sets if the TextBox is read only or not.  
    Public PropertyIsTextPredictionEnabledGets or sets if text prediction & automatic text correction functions are enabled or not.  
    Public PropertyIsVisible (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyKeyboardGets or sets which Keyboard will be used for the InputView.  
    Public PropertyMargin (Inherited from Microsoft.Maui.Controls.View)
    Public PropertyMaximumHeightRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyMaximumWidthRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyMaxLengthGets or sets the maximum number of characters allowed in the TextBox.  
    Public PropertyMinimumHeightRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyMinimumWidthRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyNavigation (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public PropertyOpacity (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyOverrideDefaultVisualStatesGets or sets if the Control's VisualStates are overridden or not. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyPaddingGets or sets the amount of padding added around the Control.  (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyParent (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyResources (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyReturnCommandGets or sets which command will be run when the user presses the Return key, either physically or via the on-screen keyboard.  
    Public PropertyReturnCommandParameterGets or sets the parameter that can be used to provide extra information for the ReturnCommand property.  
    Public PropertyRotation (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyRotationX (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyRotationY (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyScale (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyScaleX (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyScaleY (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertySelectionLengthGets or sets the selection's length.  
    Public PropertyShadow (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyStyle (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public PropertyStyleClass (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Public PropertyStyleId (Inherited from Microsoft.Maui.Controls.Element)
    Public PropertyTextGets or sets the text inside the TextBox.  
    Public PropertyTextColorGets or sets the text's Color. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyTranslationX (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyTranslationY (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyTriggers (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyVerticalContentOptionsGets or sets how the Control's Content is aligned vertically. (Inherited from Xceed.Maui.Toolkit.Control)
    Public PropertyVerticalOptions (Inherited from Microsoft.Maui.Controls.View)
    Public PropertyVisual (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyWatermarkGets or sets the watermark that will be displayed when the Text property is null or empty.  
    Public PropertyWidth (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyWidthRequest (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyWindow (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyX (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyY (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public PropertyZIndex (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    Protected Properties
     NameDescription
    Protected Internal PropertyGestureController (Inherited from Microsoft.Maui.Controls.View)
    Protected PropertyIsEnabledCore (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    Public Methods
     NameDescription
    Public MethodAddLogicalChild (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodArrange (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public MethodBatchBegin (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public MethodBatchCommit (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public MethodClearLogicalChildren (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodClearValueOverloaded.  (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodCoerceValueOverloaded.  (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodCrossPlatformArrange (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodCrossPlatformMeasure (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodFindByName (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodFocus (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public MethodForceLayout (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodGetChildElements (Inherited from Microsoft.Maui.Controls.View)
    Public MethodGetValue (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodInsertLogicalChild (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodIsSet (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodLayout (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public MethodLowerChild (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodMeasure (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodRaiseChild (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public MethodRemoveBinding (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodRemoveDynamicResource (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodRemoveLogicalChild (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodResolveControlTemplate (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Public MethodSetBinding (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodSetDynamicResource (Inherited from Microsoft.Maui.Controls.Element)
    Public MethodSetValueOverloaded.  (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public MethodUnfocus (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    Protected Methods
     NameDescription
    Protected MethodApplyBindings (Inherited from Microsoft.Maui.Controls.BindableObject)
    Protected MethodArrangeOverride (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected Internal MethodChangeVisualState (Inherited from Microsoft.Maui.Controls.View)
    Protected Internal MethodClearButtonAction  
    Protected MethodEntry_TextChanged  
    Protected MethodFinalize (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected Internal MethodGetRendererOverrides (Inherited from Microsoft.Maui.Controls.View)
    Protected MethodGetTemplateChild (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodInvalidateLayout (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodInvalidateMeasure (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodInvalidateMeasureOverride (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodLayoutChildren (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodMeasureOverride (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodOnApplyTemplateOverridden.   
    Protected MethodOnBindingContextChanged (Inherited from Microsoft.Maui.Controls.View)
    Protected MethodOnChildAdded (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodOnChildMeasureInvalidatedOverloaded.  (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodOnChildRemoved (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodOnChildrenReordered (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodOnCoerceText  
    Protected MethodOnCursorPositionChanged  
    Protected MethodOnFontAttributesChangedOverridden.   
    Protected MethodOnFontFamilyChangedOverridden.   
    Protected MethodOnFontSizeChangedOverridden.   
    Protected MethodOnHandlerChanged (Inherited from Microsoft.Maui.Controls.Element)
    Protected MethodOnHandlerChanging (Inherited from Microsoft.Maui.Controls.Element)
    Protected MethodOnIsFocusUnderlineVisibleChanged  
    Protected MethodOnMeasure (Inherited from Microsoft.Maui.Controls.TemplatedView)
    Protected MethodOnParentChanged (Inherited from Microsoft.Maui.Controls.Element)
    Protected MethodOnParentChanging (Inherited from Microsoft.Maui.Controls.Element)
    Protected MethodOnParentSet (Inherited from Microsoft.Maui.Controls.NavigableElement)
    Protected MethodOnPropertyChanged (Inherited from Xceed.Maui.Toolkit.Control)
    Protected MethodOnPropertyChanging (Inherited from Microsoft.Maui.Controls.BindableObject)
    Protected MethodOnSelectionLengthChanged  
    Protected MethodOnSizeAllocated (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodOnTextChanged  
    Protected MethodOnTextColorChangedOverridden.   
    Protected MethodRefreshIsEnabledProperty (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodShouldInvalidateOnChildAdded (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodShouldInvalidateOnChildRemoved (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Protected MethodSizeAllocated (Inherited from Microsoft.Maui.Controls.VisualElement)
    Protected MethodUnapplyBindings (Inherited from Microsoft.Maui.Controls.BindableObject)
    Protected MethodUpdateChildrenLayout (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Top
    Public Events
     NameDescription
    Public EventBindingContextChanged (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public EventChildAdded (Inherited from Microsoft.Maui.Controls.Element)
    Public EventChildRemoved (Inherited from Microsoft.Maui.Controls.Element)
    Public EventChildrenReordered (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public EventCompletedThe event that is raised when the user finalizes the Text entry process with the Return key.  
    Public EventDescendantAdded (Inherited from Microsoft.Maui.Controls.Element)
    Public EventDescendantRemoved (Inherited from Microsoft.Maui.Controls.Element)
    Public EventFocusedThe event that is raised when the TextBox is selected &, thus, in focus.  
    Public EventHandlerChanged (Inherited from Microsoft.Maui.Controls.Element)
    Public EventHandlerChanging (Inherited from Microsoft.Maui.Controls.Element)
    Public EventLayoutChanged (Inherited from Microsoft.Maui.Controls.Compatibility.Layout)
    Public EventLoaded (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public EventMeasureInvalidated (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public EventParentChanged (Inherited from Microsoft.Maui.Controls.Element)
    Public EventParentChanging (Inherited from Microsoft.Maui.Controls.Element)
    Public EventPropertyChanged (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public EventPropertyChanging (Inherited from Microsoft.Maui.Controls.BindableObject)
    Public EventSelectionChangedThe event that is raised when the value of the CursorPosition or SelectionLength properties changes.  
    Public EventSizeChanged (Inherited from Microsoft.Maui.Controls.VisualElement)
    Public EventTextChanged
    The event that is raised when the Text is modified.
     
    Public EventUnfocusedThe event that is raised when the TextBox is deselected &, therefore, no longer in focus.  
    Public EventUnloaded (Inherited from Microsoft.Maui.Controls.VisualElement)
    Top
    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    TextBox Members
    Xceed.Maui.Toolkit Namespace

    Send Feedback