Compartir a través de

  • Artículo

RichTextBox Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Represents a rich text control that supports formatted text, hyperlinks, inline images, and other rich content.

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.UIElement
      System.Windows.FrameworkElement
        System.Windows.Controls.Control
          System.Windows.Controls.RichTextBox

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

Syntax

'Declaration
<TemplateVisualStateAttribute(Name := "ReadOnly", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "Disabled", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "Unfocused", GroupName := "FocusStates")> _
<TemplateVisualStateAttribute(Name := "Normal", GroupName := "CommonStates")> _
<TemplateVisualStateAttribute(Name := "Focused", GroupName := "FocusStates")> _
<TemplateVisualStateAttribute(Name := "Valid", GroupName := "ValidationStates")> _
<ContentPropertyAttribute("Blocks", True)> _
<TemplatePartAttribute(Name := "ContentElement", Type := GetType(FrameworkElement))> _
<TemplateVisualStateAttribute(Name := "InvalidUnfocused", GroupName := "ValidationStates")> _
<TemplateVisualStateAttribute(Name := "InvalidFocused", GroupName := "ValidationStates")> _
<TemplateVisualStateAttribute(Name := "MouseOver", GroupName := "CommonStates")> _
Public Class RichTextBox _
    Inherits Control

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

<RichTextBox .../>
-or-
<RichTextBox ...>
  blocksContent
</RichTextBox>

XAML Values

  • blocksContent
    One or more object elements for types that derive from Block. Typically, these are Paragraph elements.

The RichTextBox type exposes the following members.

Constructors

  Name Description
Public methodSupported by Silverlight for Windows Phone RichTextBox Initializes a new instance of the RichTextBox class.

Top

Properties

  Name Description
Public propertySupported by Silverlight for Windows Phone AcceptsReturn Gets or sets a value that determines whether the RichTextBox allows and displays the newline or return characters when the ENTER or RETURN keys are pressed.
Public propertySupported by Silverlight for Windows Phone ActualHeight Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone ActualWidth Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone AllowDrop Gets 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 Phone Background Gets or sets a brush that provides the background of the control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone BaselineOffset Gets a value that represents the offset in pixels from the top of the content to the baseline of the first paragraph. The baseline of the paragraph is the baseline of the first line in it.
Public propertySupported by Silverlight for Windows Phone Blocks Gets the contents of the RichTextBox.
Public propertySupported by Silverlight for Windows Phone BorderBrush Gets or sets a brush that describes the border background of a control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone BorderThickness Gets or sets the border thickness of a control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone CacheMode Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone CaretBrush Gets or sets the brush that is used to render the vertical bar that indicates the insertion point.
Public property CharacterSpacing Gets 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 Phone Clip Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone ContentEnd Gets a TextPointer that indicates the end of content in the RichTextBox.
Public propertySupported by Silverlight for Windows Phone ContentStart Gets a TextPointer that indicates the start of content in the RichTextBox.
Public propertySupported by Silverlight for Windows Phone Cursor Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone DataContext Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
Protected propertySupported by Silverlight for Windows Phone DefaultStyleKey Gets or sets the key that references the default style for the control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone DesiredSize Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public property Effect Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone FlowDirection Gets 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 Phone FontFamily Gets or sets the font used to display text in the control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone FontSize Gets or sets the size of the text in this control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone FontStretch Gets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone FontStyle Gets or sets the style in which the text is rendered. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone FontWeight Gets or sets the thickness of the specified font. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone Foreground Gets or sets a brush that describes the foreground color. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone Height Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone HorizontalAlignment Gets 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 Phone HorizontalContentAlignment Gets or sets the horizontal alignment of the control's content. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone HorizontalScrollBarVisibility Gets or sets the visibility of the horizontal scroll bar.
Public propertySupported by Silverlight for Windows Phone IsEnabled Gets or sets a value indicating whether the user can interact with the control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone IsHitTestVisible Gets 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 Phone IsReadOnly Gets or sets a value that determines whether the user can change the text in the RichTextBox.
Public propertySupported by Silverlight for Windows Phone IsTabStop Gets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone Language Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.)
Public property LineHeight Gets or sets the height of each line of content.
Public property LineStackingStrategy Gets or sets a value that indicates how a line box is determined for each line of text in the RichTextBox.
Public propertySupported by Silverlight for Windows Phone Margin Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone MaxHeight Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone MaxWidth Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone MinHeight Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone MinWidth Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone Name Gets 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 Phone Opacity Gets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone OpacityMask Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone Padding Gets or sets the padding inside a control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone Parent Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone Projection Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone RenderSize Gets the final render size of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone RenderTransform Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public propertySupported by Silverlight for Windows Phone RenderTransformOrigin Gets 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 Phone Resources Gets 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 Phone Selection Gets the TextSelection in the RichTextBox.
Public propertySupported by Silverlight for Windows Phone Style Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone TabIndex Gets 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 Phone TabNavigation Gets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone Tag Gets 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 Phone Template Gets or sets a control template. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone TextAlignment Gets or sets how the text should be aligned in the RichTextBox.
Public propertySupported by Silverlight for Windows Phone TextWrapping Gets or sets how text wrapping occurs if a line of text extends beyond the available width of the RichTextBox.
Public propertySupported by Silverlight for Windows Phone Triggers Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone UseLayoutRounding Gets 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 Phone VerticalAlignment Gets 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 Phone VerticalContentAlignment Gets or sets the vertical alignment of the control's content. (Inherited from Control.)
Public propertySupported by Silverlight for Windows Phone VerticalScrollBarVisibility Gets or sets the visibility of the vertical scroll bar.
Public propertySupported by Silverlight for Windows Phone Visibility Gets 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 propertySupported by Silverlight for Windows Phone Width Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)
Public propertySupported by Silverlight for Windows Phone Xaml Gets or sets a XAML representation of the content in the RichTextBox.

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone AddHandler Adds 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 Phone ApplyTemplate Loads the relevant control template so that its parts can be referenced. (Inherited from Control.)
Public methodSupported by Silverlight for Windows Phone Arrange Positions 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 Phone ArrangeOverride Provides 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 Phone CaptureMouse Sets mouse capture to a UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone Finalize Allows 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 Phone FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows Phone Focus Attempts to set the focus on the control. (Inherited from Control.)
Public methodSupported by Silverlight for Windows Phone GetAnimationBaseValue Returns 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 Phone GetBindingExpression Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
Public methodSupported by Silverlight for Windows Phone GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetPositionFromPoint Returns a TextPointer that indicates the closest insertion position for the specified point.
Protected methodSupported by Silverlight for Windows Phone GetTemplateChild Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control.)
Public methodSupported by Silverlight for Windows Phone GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone InvalidateArrange Invalidates 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 Phone InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone Measure Updates 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 Phone MeasureOverride Provides 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 Phone MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone OnApplyTemplate When 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 Phone OnCreateAutomationPeer Returns a RichTextBoxAutomationPeer for use by the Silverlight automation infrastructure. (Overrides UIElement.OnCreateAutomationPeer().)
Protected methodSupported by Silverlight for Windows Phone OnDoubleTap Called before the DoubleTap event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnDragEnter Called before the DragEnter event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnDragLeave Called before the DragLeave event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnDragOver Called before the DragOver event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnDrop Called before the Drop event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnGotFocus Called before the GotFocus event occurs. (Overrides Control.OnGotFocus(RoutedEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnHold Called before the Hold event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnKeyDown Called when the KeyDown event occurs. (Overrides Control.OnKeyDown(KeyEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnKeyUp Called before the KeyUp event occurs. (Overrides Control.OnKeyUp(KeyEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnLostFocus Called before the LostFocus event occurs. (Overrides Control.OnLostFocus(RoutedEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnLostMouseCapture Provides handling for the LostMouseCapture event. (Overrides Control.OnLostMouseCapture(MouseEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnManipulationCompleted Called before the ManipulationCompleted event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnManipulationDelta Called before the ManipulationDelta event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnManipulationStarted Called before the ManipulationStarted event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnMouseEnter Called before the MouseEnter event occurs. (Overrides Control.OnMouseEnter(MouseEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnMouseLeave Called before the MouseLeave event occurs. (Overrides Control.OnMouseLeave(MouseEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnMouseLeftButtonDown Called before the MouseLeftButtonDown event occurs. (Overrides Control.OnMouseLeftButtonDown(MouseButtonEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnMouseLeftButtonUp Called before the MouseLeftButtonUp event occurs. (Overrides Control.OnMouseLeftButtonUp(MouseButtonEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnMouseMove Called before the MouseMove event occurs. (Overrides Control.OnMouseMove(MouseEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnMouseRightButtonDown Called before the MouseRightButtonDown event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnMouseRightButtonUp Called before the MouseRightButtonUp event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnMouseWheel Called 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 Phone OnTap Called before the Tap event occurs. (Inherited from Control.)
Protected methodSupported by Silverlight for Windows Phone OnTextInput Called before the TextInput event occurs. (Overrides Control.OnTextInput(TextCompositionEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnTextInputStart Called before the TextInputStart event occurs. (Overrides Control.OnTextInputStart(TextCompositionEventArgs).)
Protected methodSupported by Silverlight for Windows Phone OnTextInputUpdate Called before the TextInputUpdate event occurs. (Overrides Control.OnTextInputUpdate(TextCompositionEventArgs).)
Public methodSupported by Silverlight for Windows Phone ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ReleaseMouseCapture Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone RemoveHandler Removes the specified routed event handler from this UIElement. (Inherited from UIElement.)
Public methodSupported by Silverlight for Windows Phone SelectAll Selects the entire contents in the RichTextBox.
Public methodSupported by Silverlight for Windows Phone SetBinding Attaches 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 Phone SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ToString Returns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone TransformToVisual Returns 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 Phone UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)

Top

Events

  Name Description
Public eventSupported by Silverlight for Windows Phone BindingValidationError Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows Phone ContentChanged Occurs when the content changes in a RichTextBox.
Public event DataContextChanged Occurs when the data context for this element changes. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows Phone DoubleTap Occurs when a DoubleTap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public event DragEnter Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.)
Public event DragLeave Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.)
Public event DragOver Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.)
Public event Drop Occurs 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 Phone GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone Hold Occurs when a Hold gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone IsEnabledChanged Occurs when the IsEnabled property changes. (Inherited from Control.)
Public eventSupported by Silverlight for Windows Phone KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone LayoutUpdated Occurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows Phone Loaded Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows Phone LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone LostMouseCapture Occurs when the UIElement loses mouse capture. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone ManipulationCompleted Occurs when a manipulation and inertia on the UIElement is complete. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone ManipulationDelta Occurs when the input device changes position during a manipulation. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement.)
Public event MediaCommand Occurs when a button is pressed on a remote control. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone MouseEnter Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone MouseLeave Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone MouseLeftButtonDown Occurs 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 Phone MouseLeftButtonUp Occurs 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 Phone MouseMove Occurs 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 event MouseRightButtonDown Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.)
Public event MouseRightButtonUp Occurs 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 Phone MouseWheel Occurs 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 Phone SelectionChanged Occurs when the text selection has changed.
Public eventSupported by Silverlight for Windows Phone SizeChanged Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Public eventSupported by Silverlight for Windows Phone Tap Occurs when a Tap gesture is committed while over this UIElement. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone TextInput Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone TextInputStart Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone TextInputUpdate Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public eventSupported by Silverlight for Windows Phone Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)

Top

Fields

  Name Description
Public fieldStatic memberSupported by Silverlight for Windows Phone AcceptsReturnProperty Identifies the AcceptsReturn dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone CaretBrushProperty Identifies the CaretBrush dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone IsReadOnlyProperty Identifies the IsReadOnly dependency property.
Public fieldStatic member LineHeightProperty Identifies the LineHeight dependency property.
Public fieldStatic member LineStackingStrategyProperty Identifies the LineStackingStrategy dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone TextAlignmentProperty Identifies the TextAlignment dependency property.
Public fieldStatic memberSupported by Silverlight for Windows Phone TextWrappingProperty Identifies the TextWrapping dependency property.

Top

Remarks

You can use the RichTextBox control to display, enter, format, and edit rich text.

NoteNote:

Silverlight for Windows Phone In this release of Silverlight for Windows Phone, RichTextBox is read-only.

The following illustration shows an application that uses the RichTextBox.

Silverlight Text Editor

RichTextBox provides more advanced formatting features than the TextBox and TextBlock controls. You can apply character and paragraph formatting to the text in the RichTextBox. For example, you can apply Bold, Italic, and Underline to any portion of the text in the control.

The content property of RichTextBox is the Blocks property, which is based on the Paragraph element. Content can contain many types of elements including formatted text, hyperlinks, and images.

You can use the Hyperlink element to display hyperlinks in a RichTextBox. You must set the IsReadOnly property of the RichTextBox to true for hyperlinks to work.

You can use the RichTextBox to display text with UI elements that are derived from UIElement, such as images. You can do this by using the InlineUIContainer.

RichTextBox has a read-only mode. You can enable read-only mode by setting the IsReadOnly property to true.

Customizing the RichTextBox Control

To apply the same property settings to multiple RichTextBox controls, use the Style property. To change the visual structure and visual behavior of a RichTextBox, 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 RichTextBox is set by its default style, the property might change from its default value when the RichTextBox appears in the application. For more information, see Dependency Property Value Precedence. You can get the default style and template for RichTextBox from RichTextBox Styles and Templates.

NoteNote:

Setting a visual property will only have an effect if that property is both present in RichTextBox 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.

Common Tasks

The following table provides information about tasks that are typically associated with the RichTextBox.

Task

Implementation

Set content

Use the Paragraph element to set content. For more information, see RichTextBox Overview.

Display text with inline UIElement objects such as an Image or a Calendar.

Use the InlineUIContainer element. For more information, see RichTextBox Overview.

Display hyperlinks

Use the Hyperlink element. For more information, see RichTextBox Overview.

Display content in read-only mode

Use the IsReadOnly property. For more information, see RichTextBox Overview.

Programmatically select content

Use the Selection property and the TextSelection class. For more information, see RichTextBox Overview.

Programmatically format content

Use the GetPropertyValue and ApplyPropertyValue methods. For more information, see RichTextBox Overview.

Programmatically traverse content

Use the TextPointer class.

Version Notes

Silverlight for Windows Phone Silverlight for Windows Phone

In Silverlight for Windows Phone, RichTextBox is read-only.

Examples

The following code shows how to create a RichTextBox with a paragraph and some bold text.

<!--A RichTextBox with intial content in it.-->
<RichTextBox VerticalScrollBarVisibility="Auto">
    <Paragraph>
        A RichTextBox with <Bold>initial content</Bold> in it.
    </Paragraph>
</RichTextBox>

'A RichTextBox with intial content in it.
Private Sub ContentRTB()
    'Create a new RichTextBox with its VerticalScrollBarVisibility property set to Auto.
    Dim MyRTB As New RichTextBox()
    MyRTB.VerticalScrollBarVisibility = ScrollBarVisibility.Auto

    ' Create a Run of plain text and some bold text.
    Dim myRun1 As New Run()
    myRun1.Text = "A RichTextBox with "
    Dim myBold As New Bold()
    myBold.Inlines.Add("initial content ")
    Dim myRun2 As New Run()
    myRun2.Text = "in it."

    ' Create a paragraph and add the Run and Bold to it.
    Dim myParagraph As New Paragraph()
    myParagraph.Inlines.Add(myRun1)
    myParagraph.Inlines.Add(myBold)
    myParagraph.Inlines.Add(myRun2)

    ' Add the paragraph to the RichTextBox.
    MyRTB.Blocks.Add(myParagraph)

    'Add the RichTextBox to the StackPanel.
    MySP.Children.Add(MyRTB)
End Sub

//A RichTextBox with intial content in it.
private void ContentRTB()
{
    //Create a new RichTextBox with its VerticalScrollBarVisibility property set to Auto.
    RichTextBox MyRTB = new RichTextBox();
    MyRTB.VerticalScrollBarVisibility = ScrollBarVisibility.Auto;

    // Create a Run of plain text and some bold text.
    Run myRun1 = new Run();
    myRun1.Text = "A RichTextBox with ";
    Bold myBold = new Bold();
    myBold.Inlines.Add("initial content ");
    Run myRun2 = new Run();
    myRun2.Text = "in it.";

    // Create a paragraph and add the Run and Bold to it.
    Paragraph myParagraph = new Paragraph();
    myParagraph.Inlines.Add(myRun1);
    myParagraph.Inlines.Add(myBold);
    myParagraph.Inlines.Add(myRun2);

    // Add the paragraph to the RichTextBox.
    MyRTB.Blocks.Add(myParagraph);

    //Add the RichTextBox to the StackPanel.
    MySP.Children.Add(MyRTB);
}

Version Information

Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

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

Thread Safety

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