Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

TextBox Class

Represents a control that can be used to display single-format, multi-line text.

Namespace:  System.Windows.Controls
Assembly:  System.Windows (in System.Windows.dll)

[TemplateVisualStateAttribute(Name = "Unfocused", GroupName = "FocusStates")]
[TemplateVisualStateAttribute(Name = "ReadOnly", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Focused", GroupName = "FocusStates")]
[TemplateVisualStateAttribute(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "MouseOver", GroupName = "CommonStates")]
[TemplateVisualStateAttribute(Name = "Valid", GroupName = "ValidationStates")]
[TemplateVisualStateAttribute(Name = "InvalidUnfocused", GroupName = "ValidationStates")]
[TemplateVisualStateAttribute(Name = "InvalidFocused", GroupName = "ValidationStates")]
[TemplatePartAttribute(Name = "ContentElement", Type = typeof(FrameworkElement))]
[TemplateVisualStateAttribute(Name = "Normal", GroupName = "CommonStates")]
public class TextBox : Control

The TextBox type exposes the following members.

  NameDescription
Public methodSupported by Silverlight for Windows PhoneTextBoxInitializes a new instance of the TextBox class.
Top

  NameDescription
Public propertySupported by Silverlight for Windows PhoneAcceptsReturnGets or sets the value that determines whether the text box allows and displays the newline or return characters.
Public propertySupported by Silverlight for Windows PhoneActualHeightGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneActualWidthGets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneAllowDropGets or sets a value that determines whether this UIElement can be a drop target for purposes of Silverlight drag-and-drop operations. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneBackgroundGets or sets a brush that provides the background of the control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneBaselineOffsetGets a value by which each line of text is offset from a baseline.
Public propertySupported by Silverlight for Windows PhoneBorderBrushGets or sets a brush that describes the border background of a control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneBorderThicknessGets or sets the border thickness of a control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneCacheModeGets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneCaretBrushGets or sets the brush that is used to render the vertical bar that indicates the insertion point.
Public propertyCharacterSpacingGets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneClipGets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneCursorGets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneDataContextGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
Protected propertySupported by Silverlight for Windows PhoneDefaultStyleKeyGets or sets the key that references the default style for the control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneDesiredSizeGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyEffectGets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneFlowDirectionGets or sets the direction that text and other user interface elements flow within any parent element that controls their layout. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneFontFamilyGets or sets the font used to display text in the control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneFontSizeGets or sets the size of the text in this control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneFontSourceGets or sets the font source that is applied to the TextBox for rendering content.
Public propertySupported by Silverlight for Windows PhoneFontStretchGets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneFontStyleGets or sets the style in which the text is rendered. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneFontWeightGets or sets the thickness of the specified font. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneForegroundGets or sets a brush that describes the foreground color. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneHeightGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneHorizontalAlignmentGets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneHorizontalContentAlignmentGets or sets the horizontal alignment of the control's content. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneHorizontalScrollBarVisibilityGets or sets the visibility of the horizontal scroll bar.
Public propertySupported by Silverlight for Windows PhoneInputScopeGets or sets the context for input used by this TextBox.
Public propertySupported by Silverlight for Windows PhoneIsEnabledGets or sets a value indicating whether the user can interact with the control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneIsHitTestVisibleGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneIsReadOnlyGets or sets the value that determines if the user can change the text in the text box.
Public propertySupported by Silverlight for Windows PhoneIsTabStopGets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneLanguageGets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Public propertyLineHeightGets or sets the height of each line of content.
Public propertyLineStackingStrategyGets or sets a value that indicates how a line box is determined for each line of text in the TextBox.
Public propertySupported by Silverlight for Windows PhoneMarginGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMaxHeightGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMaxLengthGets or sets the value that determines the maximum number of characters allowed for user input.
Public propertySupported by Silverlight for Windows PhoneMaxWidthGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMinHeightGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneMinWidthGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneNameGets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneOpacityGets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneOpacityMaskGets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhonePaddingGets or sets the padding inside a control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneParentGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneProjectionGets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneRenderSizeGets the final render size of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneRenderTransformGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneRenderTransformOriginGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneResourcesGets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneSelectedTextGets or sets the content of the current selection in the text box.
Public propertySupported by Silverlight for Windows PhoneSelectionBackgroundGets or sets the brush that fills the background of the selected text.
Public propertySupported by Silverlight for Windows PhoneSelectionForegroundGets or sets the brush used for the selected text in the text box.
Public propertySupported by Silverlight for Windows PhoneSelectionLengthGets or sets the number of characters in the current selection in the text box.
Public propertySupported by Silverlight for Windows PhoneSelectionStartGets or sets the starting position of the text selected in the text box.
Public propertySupported by Silverlight for Windows PhoneStyleGets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneTabIndexGets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneTabNavigationGets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneTagGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneTemplateGets or sets a control template. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneTextGets or sets the text contents of the text box.
Public propertySupported by Silverlight for Windows PhoneTextAlignmentGets or sets how the text should be aligned in the text box.
Public propertySupported by Silverlight for Windows PhoneTextWrappingGets or sets how line breaking occurs if a line of text extends beyond the available width of the text box.
Public propertySupported by Silverlight for Windows PhoneTriggersGets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneUseLayoutRoundingGets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows PhoneVerticalAlignmentGets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows PhoneVerticalContentAlignmentGets or sets the vertical alignment of the control's content. (Inherited from Control.)
Public propertySupported by Silverlight for Windows PhoneVerticalScrollBarVisibilityGets or sets the visibility of the vertical scroll bar.
Public propertySupported by Silverlight for Windows PhoneVisibilityGets or sets the visibility of a UIElement. A UIElement that is not visible does not render and does not communicate its desired size to layout. (Inherited from UIElement.)
Public propertyWatermarkThis property is not implemented.
Public propertySupported by Silverlight for Windows PhoneWidthGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)
Top

  NameDescription
Public methodSupported by Silverlight for Windows PhoneAddHandlerAdds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for routed event that had already been marked as handled by another element along the event route. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneApplyTemplateLoads the relevant control template so that its parts can be referenced. (Inherited from Control.)
Public methodSupported by Silverlight for Windows PhoneArrangePositions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement.)
Protected methodSupported by Silverlight for Windows PhoneArrangeOverrideProvides the behavior for the Arrange pass of Silverlight layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneCaptureMouseSets mouse capture to a UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneFindNameRetrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneFocusAttempts to set the focus on the control. (Inherited from Control.)
Public methodSupported by Silverlight for Windows PhoneGetAnimationBaseValueReturns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneGetBindingExpressionRetrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetRectFromCharacterIndex(Int32)Returns a rectangle for the leading edge of the character at the specified index.
Public methodSupported by Silverlight for Windows PhoneGetRectFromCharacterIndex(Int32, Boolean)Returns a rectangle for the leading or trailing edge of the character at the specified index.
Protected methodSupported by Silverlight for Windows PhoneGetTemplateChildRetrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control.)
Public methodSupported by Silverlight for Windows PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneInvalidateArrangeInvalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneInvalidateMeasureInvalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneMeasureUpdates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement.)
Protected methodSupported by Silverlight for Windows PhoneMeasureOverrideProvides the behavior for the Measure pass of Silverlight layout. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement.)
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneOnApplyTemplateWhen overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks. (Inherited from FrameworkElement.)
Protected methodSupported by Silverlight for Windows PhoneOnCreateAutomationPeerReturns a TextBoxAutomationPeer for use by the Silverlight automation infrastructure. (Overrides UIElement.OnCreateAutomationPeer().)
Protected methodSupported by Silverlight for Windows PhoneOnDoubleTapCalled before the DoubleTap event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnDragEnterCalled before the DragEnter event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnDragLeaveCalled before the DragLeave event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnDragOverCalled before the DragOver event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnDropCalled before the Drop event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnGotFocusCalled before GotFocus event occurs. (Overrides Control.OnGotFocus(RoutedEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnHoldCalled before the Hold event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnKeyDownCalled when KeyDown event occurs. (Overrides Control.OnKeyDown(KeyEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnKeyUpCalled before KeyUp event occurs. (Overrides Control.OnKeyUp(KeyEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnLostFocusCalled before LostFocus event occurs. (Overrides Control.OnLostFocus(RoutedEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnLostMouseCaptureProvides handling for the LostMouseCapture event. (Overrides Control.OnLostMouseCapture(MouseEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnManipulationCompletedCalled before the ManipulationCompleted event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnManipulationDeltaCalled before the ManipulationDelta event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnManipulationStartedCalled before the ManipulationStarted event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnMouseEnterCalled before MouseEnter event occurs. (Overrides Control.OnMouseEnter(MouseEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnMouseLeaveCalled before MouseLeave event occurs. (Overrides Control.OnMouseLeave(MouseEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnMouseLeftButtonDownCalled before MouseLeftButtonDown event occurs. (Overrides Control.OnMouseLeftButtonDown(MouseButtonEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnMouseLeftButtonUpCalled before MouseLeftButtonUp event occurs. (Overrides Control.OnMouseLeftButtonUp(MouseButtonEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnMouseMoveCalled before MouseMove event occurs. (Overrides Control.OnMouseMove(MouseEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnMouseRightButtonDownCalled before the MouseRightButtonDown event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnMouseRightButtonUpCalled before the MouseRightButtonUp event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnMouseWheelCalled before the MouseWheel event occurs to provide handling for the event in a derived class without attaching a delegate. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnTapCalled before the Tap event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows PhoneOnTextInputCalled before the TextInput event occurs. (Overrides Control.OnTextInput(TextCompositionEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnTextInputStartCalled before the TextInputStart event occurs. (Overrides Control.OnTextInputStart(TextCompositionEventArgs).)
Protected methodSupported by Silverlight for Windows PhoneOnTextInputUpdateCalled before the TextInputUpdate event occurs. (Overrides Control.OnTextInputUpdate(TextCompositionEventArgs).)
Public methodSupported by Silverlight for Windows PhoneReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneReleaseMouseCaptureRemoves mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneRemoveHandlerRemoves the specified routed event handler from this UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneSelectSelects a range of text in the text box.
Public methodSupported by Silverlight for Windows PhoneSelectAllSelects the entire contents of the text box.
Public methodSupported by Silverlight for Windows PhoneSetBindingAttaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows PhoneSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows PhoneToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneTransformToVisualReturns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows PhoneUpdateLayoutEnsures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)
Top

  NameDescription
Public eventSupported by Silverlight for Windows PhoneBindingValidationErrorOccurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
Public eventDataContextChangedOccurs when the data context for this element changes. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneDoubleTapOccurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventDragEnterOccurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.)
Public eventDragLeaveOccurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.)
Public eventDragOverOccurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
Public eventDropOccurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneGotFocusOccurs when a UIElement receives focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneHoldOccurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneIsEnabledChangedOccurs when the IsEnabled property changes. (Inherited from Control.)
Public eventSupported by Silverlight for Windows PhoneKeyDownOccurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneKeyUpOccurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneLayoutUpdatedOccurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneLoadedOccurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneLostFocusOccurs when a UIElement loses focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneLostMouseCaptureOccurs when the UIElement loses mouse capture. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneManipulationCompletedOccurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneManipulationDeltaOccurs when the input device changes position during a manipulation. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneManipulationStartedOccurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
Public eventMediaCommandOccurs when a button is pressed on a remote control. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseEnterOccurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseLeaveOccurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseLeftButtonDownOccurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseLeftButtonUpOccurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseMoveOccurs when the coordinate position of the mouse (or stylus) changes while over a UIElement (or while a UIElement holds mouse capture). (Inherited from UIElement.)
Public eventMouseRightButtonDownOccurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public eventMouseRightButtonUpOccurs when the right mouse button is released while the mouse pointer is over a UIElement. However, this event will only be raised if a caller marks the preceding MouseRightButtonDown event as handled; see Remarks. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneMouseWheelOccurs when the user rotates the mouse wheel while the mouse pointer is over a UIElement, or the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneSelectionChangedOccurs when the text selection has changed.
Public eventSupported by Silverlight for Windows PhoneSizeChangedOccurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows PhoneTapOccurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneTextChangedOccurs when content changes in the text box.
Public eventSupported by Silverlight for Windows PhoneTextInputOccurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneTextInputStartOccurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneTextInputUpdateOccurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows PhoneUnloadedOccurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)
Top

  NameDescription
Public fieldStatic memberSupported by Silverlight for Windows PhoneAcceptsReturnPropertyIdentifies the AcceptsReturn dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneCaretBrushPropertyIdentifies the CaretBrush dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneInputScopePropertyIdentifies the InputScope dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneIsReadOnlyPropertyIdentifies the IsReadOnly dependency property.
Public fieldStatic memberLineHeightPropertyIdentifies the LineHeight dependency property.
Public fieldStatic memberLineStackingStrategyPropertyIdentifies the LineStackingStrategy dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneMaxLengthPropertyIdentifies the MaxLength dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneSelectionBackgroundPropertyIdentifies the SelectionBackground dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneSelectionForegroundPropertyIdentifies the SelectionForeground dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneTextAlignmentPropertyIdentifies the TextAlignment dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneTextPropertyIdentifies the Text dependency property.
Public fieldStatic memberSupported by Silverlight for Windows PhoneTextWrappingPropertyIdentifies the TextWrapping dependency property.
Public fieldStatic memberWatermarkPropertyIdentifies the Watermark dependency property.
Top

You can enable multi-line text in a TextBox control by using the AcceptsReturn property. Use the HorizontalScrollBarVisibility or VerticalScrollBarVisibility property to enable the horizontal scrollbars or the vertical scrollbars. For an example that demonstrates a multi-line text box control with scrollbars, see the AcceptsReturn property.

You may want to use a text box to display text, but you may not want the user to be able to edit the text. You can do this by using the IsReadOnly property. If you set the IsReadOnly property of a text box to true, edit commands are not supported and the KeyUp and KeyDown events are marked as handled. If you require formatted text that can not be edited by the user, use the TextBlock control. If you require an editable text box that accepts passwords or other sensitive input, see PasswordBox.

You can modify the border of the TextBox by using the BorderThickness and BorderBrush properties. The best way to hide the border around a TextBox is to set the BorderThickness property of the TextBox to 0.

You must arrange the visual child when you override the ArrangeOverride method. Otherwise, the arrange behavior may be undefined.

Content Model: The content property of the TextBox is Text. For more information about the content model for a text box, see Control Content Models.

Customizing the TextBox Control

To apply the same property settings to multiple TextBox controls, use the Style property. To change the visual structure and visual behavior of a TextBox, copy and modify its default style and template. For more information, see Control Customization.

Dependency properties for this control might be set by the default style of the control. If a dependency property for a TextBox is set by its default style, the property might change from its default value when the TextBox appears in the application. For more information, see Dependency Property Value Precedence. You can get the default style and template for TextBox from TextBox Styles and Templates.

NoteNote:

Setting a visual property will only have an effect if that property is both present in TextBox control's default template and is set by using a TemplateBinding. You can find a list of visual properties in the "Changing the Visual Structure of a Control" section in Customizing the Appearance of an Existing Control by Using a ControlTemplate.

Version Notes

Silverlight for Windows Phone Silverlight for Windows Phone

In Windows Phone OS 7.1, when you set the FontFamily property to a font that is downloaded or contained in a file, the TextBox renders at the position (0,0). When the font has finished downloading the application renders again with the TextBox in the correct location.

The following code example shows text box controls that demonstrate various properties and events of a TextBox object.

Run this sample


<StackPanel x:Name="LayoutRoot" Background="White">

    <TextBlock Margin="20,20,0,0" Text="Type Text Here"/>

    <TextBox x:Name="ReadWriteTB" TextChanged="ReadWriteTB_TextChanged"  IsReadOnly="False" HorizontalAlignment="Left" Margin="20,5,0,0" Height="35" Width="200" />

    <TextBlock Margin="20,20,0,0" Text="Read Only TextBox"/>

    <TextBox x:Name="ReadOnlyTB"  IsReadOnly="True" HorizontalAlignment="Left" Margin="20,5,0,0" Height="35" Width="200" />

    <TextBlock Margin="20,30,0,0" Text="Search Type TextBox" />

    <TextBlock Margin="20,0,0,0" FontSize="11">
        The following text box has a watermark text (Search). The text is gray until you click inside the text box. 
        <LineBreak />
        When you click inside the text box the watermark text is removed and the cursor appears ready for input.
    </TextBlock>

    <TextBox x:Name="SearchTB" Margin="20,5,0,0" Text="Search" HorizontalAlignment="Left" Height="35" Width="200" Foreground="Gray" GotFocus="SearchTB_GotFocus" LostFocus="SearchTB_LostFocus" />

    <TextBlock Margin="20,40,0,0" Text="Demonstrating styles for TextBox" />

    <TextBlock Margin="20,0,0,0" FontSize="11">
        Select the following text to view the results of SelectionForeground and SelectionBackground properties.
    </TextBlock>

    <TextBox Text="Styles" Margin="20,5,0,0" HorizontalAlignment="Left" Width="200" Height="35" FontFamily="Arial" FontSize="15" Foreground="White" Background="Black" BorderBrush="White" SelectionForeground="Black">
        <TextBox.SelectionBackground>
            <LinearGradientBrush StartPoint="0,0" EndPoint="0,1">
                <GradientStop Color="Gray" Offset="0.0" />
                <GradientStop Color="White" Offset="1.0" />
            </LinearGradientBrush>
        </TextBox.SelectionBackground>
    </TextBox>
</StackPanel>



public partial class Page : UserControl
{
    public Page()
    {
        InitializeComponent();
    }


    //The following method displays the text entered in ReadWriteTB in ReadOnlyTB.
    private void ReadWriteTB_TextChanged(object sender, RoutedEventArgs e)
    {
        ReadOnlyTB.Text = ReadWriteTB.Text;
    }

    //The foreground color of the text in SearchTB is set to Magenta when SearchTB
    //gets focus.
    private void SearchTB_GotFocus(object sender, RoutedEventArgs e)
    {
        SearchTB.Text = "";
        SolidColorBrush Brush1 = new SolidColorBrush();
        Brush1.Color = Colors.Magenta;
        SearchTB.Foreground = Brush1;

    }

    //The foreground color of the text in SearchTB is set to Blue when SearchTB
    //loses focus. Also, if SearchTB loses focus and no text is entered, the
    //text "Search" is displayed.
    private void SearchTB_LostFocus(object sender, RoutedEventArgs e)
    {
        if (SearchTB.Text == String.Empty)
        {
            SearchTB.Text = "Search";
            SolidColorBrush Brush2 = new SolidColorBrush();
            Brush2.Color = Colors.Blue;
            SearchTB.Foreground = Brush2;
        }
    }
}


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

Show:
© 2014 Microsoft