RichTextBlock Class

Represents a control that displays read-only rich text.

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.UIElement
      System.Windows.FrameworkElement
        System.Windows.Controls.RichTextBlock

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

Syntax

'Declaration
<ContentPropertyAttribute("Blocks", True)> _
Public NotInheritable Class RichTextBlock _
    Inherits FrameworkElement
[ContentPropertyAttribute("Blocks", true)]
public sealed class RichTextBlock : FrameworkElement

The RichTextBlock type exposes the following members.

Constructors

  Name Description
Public method RichTextBlock Initializes a new instance of the RichTextBlock class.

Top

Properties

  Name Description
Public property ActualHeight Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.)
Public property ActualWidth Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.)
Public property 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 property 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 property Blocks Gets the contents of the RichTextBlock.
Public property CacheMode Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.)
Public property CharacterSpacing Gets or sets the distance between characters of text in the control measured in 1000ths of the font size.
Public property Clip Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.)
Public property ContentEnd Gets a TextPointer that indicates the end of content in the RichTextBlock.
Public property ContentStart Gets a TextPointer that indicates the start of content in the RichTextBlock.
Public property Cursor Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.)
Public property DataContext Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.)
Public property DesiredSize Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.)
Public property 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 property 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 property FontFamily Gets or sets the font used to display text in the control.
Public property FontSize Gets or sets the size of the text in this control.
Public property FontStretch Gets or sets the degree to which a font is condensed or expanded on the screen.
Public property FontStyle Gets or sets the style in which the text is rendered.
Public property FontWeight Gets or sets the thickness of the specified font.
Public property Foreground Gets or sets a brush that describes the foreground color.
Public property HasOverflowContent Gets or sets a value that indicates whether the RichTextBlock has overflow content.
Public property Height Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.)
Public property 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 property IsHitTestVisible Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.)
Public property IsTextSelectionEnabled Gets or sets a value that indicates whether text selection is enabled in RichTextBlock.
Public property 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 RichTextBlock.
Public property Margin Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.)
Public property MaxHeight Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public property MaxWidth Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public property MinHeight Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public property MinWidth Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.)
Public property 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 property Opacity Gets or sets the degree of the object's opacity. (Inherited from UIElement.)
Public property OpacityMask Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.)
Public property OverflowContentTarget Gets or sets the RichTextBlockOverflow that will consume the overflow content of this RichTextBlock.
Public property Padding Gets or sets the padding inside a control.
Public property Parent Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.)
Public property Projection Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.)
Public property RenderSize Gets the final render size of a UIElement. (Inherited from UIElement.)
Public property RenderTransform Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.)
Public property 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 property 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 property SelectedText Gets the plain text of the current selection in RichTextBlock.
Public property SelectionEnd Gets a TextPointer that indicates the start of the selection in the RichTextBlock or a chain of linked containers.
Public property SelectionStart Gets a TextPointer that indicates the start of the selection in a RichTextBlock or a chain of linked containers.
Public property Style Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.)
Public property Tag Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.)
Public property TextAlignment Gets or sets how the text should be aligned in the RichTextBlock.
Public property TextTrimming Gets or sets the text trimming behavior to employ when content overflows the content area.
Public property TextWrapping Gets or sets how text wrapping occurs if a line of text extends beyond the available width of the RichTextBlock.
Public property Triggers Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.)
Public property 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 property 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 property 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 property Width Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.)

Top

Methods

  Name Description
Public method 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 method 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 method 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 method CaptureMouse Sets mouse capture to a UIElement. (Inherited from UIElement.)
Public method CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public method ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method 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 method FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.)
Public method 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 method GetBindingExpression Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetPositionFromPoint Returns a TextPointer that indicates the closest insertion position for the specified point.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public method 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 method InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.)
Public method 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 method 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 method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method 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 method OnCreateAutomationPeer When implemented in a derived class, returns class-specific AutomationPeer implementations for the Silverlight automation infrastructure. (Inherited from UIElement.)
Public method ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public method ReleaseMouseCapture Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.)
Public method RemoveHandler Removes the specified routed event handler from this UIElement. (Inherited from UIElement.)
Public method Select Selects the content between two positions indicated by textpointer objects.
Public method SelectAll Selects the entire contents in the RichTextBlock.
Public method SetBinding Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.)
Public method SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.)
Public method UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.)

Top

Events

  Name Description
Public event BindingValidationError Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.)
Public event DataContextChanged Occurs when the data context for this element changes. (Inherited from FrameworkElement.)
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 event GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement.)
Public event KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.)
Public event KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.)
Public event LayoutUpdated Occurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.)
Public event Loaded Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.)
Public event LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement.)
Public event LostMouseCapture Occurs when the UIElement loses mouse capture. (Inherited from UIElement.)
Public event MediaCommand Occurs when a button is pressed on a remote control. (Inherited from UIElement.)
Public event MouseEnter Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.)
Public event MouseLeave Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.)
Public event 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 event 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 event 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 event 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 event SelectionChanged Occurs when the text selection has changed.
Public event SizeChanged Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.)
Public event TextInput Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.)
Public event TextInputStart Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.)
Public event TextInputUpdate Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.)
Public event Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.)

Top

Fields

  Name Description
Public fieldStatic member CharacterSpacingProperty Identifies the CharacterSpacing dependency property.
Public fieldStatic member FontFamilyProperty Identifies the FontFamily dependency property.
Public fieldStatic member FontSizeProperty Identifies the FontSize dependency property.
Public fieldStatic member FontStretchProperty Identifies the FontStretch dependency property.
Public fieldStatic member FontStyleProperty Identifies the FontStyle dependency property.
Public fieldStatic member FontWeightProperty Identifies the FontWeight dependency property.
Public fieldStatic member ForegroundProperty Identifies the Foreground dependency property.
Public fieldStatic member HasOverflowContentProperty Identifies the HasOverflowContent dependency property.
Public fieldStatic member IsTextSelectionEnabledProperty Identifies the IsTextSelectionEnabled dependency property.
Public fieldStatic member LineHeightProperty Identifies the LineHeight dependency property.
Public fieldStatic member LineStackingStrategyProperty Identifies the LineStackingStrategy dependency property.
Public fieldStatic member OverflowContentTargetProperty Identifies the OverflowContentTarget dependency property.
Public fieldStatic member PaddingProperty Identifies the Padding dependency property.
Public fieldStatic member SelectedTextProperty Identifies the SelectedText dependency property.
Public fieldStatic member TextAlignmentProperty Identifies the TextAlignment dependency property.
Public fieldStatic member TextTrimmingProperty Identifies the TextTrimming dependency property.
Public fieldStatic member TextWrappingProperty Identifies the TextWrapping dependency property.

Top

Version Information

Silverlight

Supported in: 5

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.