RichTextBlock Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
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 | |
|---|---|---|
.gif "Public method") |
RichTextBlock | Initializes a new instance of the RichTextBlock class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ActualHeight | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement.) |
|
ActualWidth | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement.) |
|
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.) |
|
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. |
|
Blocks | Gets the contents of the RichTextBlock. |
|
CacheMode | Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement.) |
|
CharacterSpacing | Gets or sets the distance between characters of text in the control measured in 1000ths of the font size. |
|
Clip | Gets or sets the Geometry used to define the outline of the contents of a UIElement. (Inherited from UIElement.) |
|
ContentEnd | Gets a TextPointer that indicates the end of content in the RichTextBlock. |
|
ContentStart | Gets a TextPointer that indicates the start of content in the RichTextBlock. |
|
Cursor | Gets or sets the cursor image that displays while the mouse pointer is over a FrameworkElement. (Inherited from FrameworkElement.) |
|
DataContext | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement.) |
|
DesiredSize | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement.) |
|
Dispatcher | Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.) |
|
Effect | Gets or sets the pixel shader effect to use for rendering this UIElement. (Inherited from UIElement.) |
|
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.) |
|
FontFamily | Gets or sets the font used to display text in the control. |
|
FontSize | Gets or sets the size of the text in this control. |
|
FontStretch | Gets or sets the degree to which a font is condensed or expanded on the screen. |
|
FontStyle | Gets or sets the style in which the text is rendered. |
|
FontWeight | Gets or sets the thickness of the specified font. |
|
Foreground | Gets or sets a brush that describes the foreground color. |
|
HasOverflowContent | Gets or sets a value that indicates whether the RichTextBlock has overflow content. |
|
Height | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement.) |
|
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.) |
|
IsHitTestVisible | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement.) |
|
IsTextSelectionEnabled | Gets or sets a value that indicates whether text selection is enabled in RichTextBlock. |
|
Language | Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement.) |
|
LineHeight | Gets or sets the height of each line of content. |
|
LineStackingStrategy | Gets or sets a value that indicates how a line box is determined for each line of text in the RichTextBlock. |
|
Margin | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MaxHeight | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MaxWidth | Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MinHeight | Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
MinWidth | Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement.) |
|
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.) |
|
Opacity | Gets or sets the degree of the object's opacity. (Inherited from UIElement.) |
|
OpacityMask | Gets or sets the brush used to alter the opacity of regions of this object. (Inherited from UIElement.) |
|
OverflowContentTarget | Gets or sets the RichTextBlockOverflow that will consume the overflow content of this RichTextBlock. |
|
Padding | Gets or sets the padding inside a control. |
|
Parent | Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement.) |
|
Projection | Gets or sets the perspective projection (3-D effect) to apply when rendering this UIElement. (Inherited from UIElement.) |
|
RenderSize | Gets the final render size of a UIElement. (Inherited from UIElement.) |
|
RenderTransform | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement.) |
|
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.) |
|
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.) |
|
SelectedText | Gets the plain text of the current selection in RichTextBlock. |
|
SelectionEnd | Gets a TextPointer that indicates the start of the selection in the RichTextBlock or a chain of linked containers. |
|
SelectionStart | Gets a TextPointer that indicates the start of the selection in a RichTextBlock or a chain of linked containers. |
|
Style | Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement.) |
|
Tag | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement.) |
|
TextAlignment | Gets or sets how the text should be aligned in the RichTextBlock. |
|
TextTrimming | Gets or sets the text trimming behavior to employ when content overflows the content area. |
|
TextWrapping | Gets or sets how text wrapping occurs if a line of text extends beyond the available width of the RichTextBlock. |
|
Triggers | Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement.) |
|
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.) |
|
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.) |
|
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.) |
|
Width | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
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.) |
|
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.) |
.gif "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.) |
|
CaptureMouse | Sets mouse capture to a UIElement. (Inherited from UIElement.) |
|
CheckAccess | Determines whether the calling thread has access to this object. (Inherited from DependencyObject.) |
|
ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject.) |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
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.) |
|
FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement.) |
|
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.) |
|
GetBindingExpression | Retrieves the BindingExpression for a dependency property where a binding is established. (Inherited from FrameworkElement.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetPositionFromPoint | Returns a TextPointer that indicates the closest insertion position for the specified point. |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.) |
|
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.) |
|
InvalidateMeasure | Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement.) |
|
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.) |
|
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.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
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.) |
|
OnCreateAutomationPeer | When implemented in a derived class, returns class-specific AutomationPeer implementations for the Silverlight automation infrastructure. (Inherited from UIElement.) |
|
ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.) |
|
ReleaseMouseCapture | Removes mouse capture from a UIElement. After this call, typically no object holds mouse capture. (Inherited from UIElement.) |
|
RemoveHandler | Removes the specified routed event handler from this UIElement. (Inherited from UIElement.) |
|
Select | Selects the content between two positions indicated by textpointer objects. |
|
SelectAll | Selects the entire contents in the RichTextBlock. |
|
SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object, and returns a BindingExpressionBase for possible later use. (Inherited from FrameworkElement.) |
|
SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
TransformToVisual | Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement.) |
|
UpdateLayout | Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
BindingValidationError | Occurs when a data validation error is reported by a binding source. (Inherited from FrameworkElement.) |
|
DataContextChanged | Occurs when the data context for this element changes. (Inherited from FrameworkElement.) |
|
DragEnter | Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement.) |
|
DragLeave | Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement.) |
|
DragOver | Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement.) |
|
Drop | Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement.) |
|
GotFocus | Occurs when a UIElement receives focus. (Inherited from UIElement.) |
|
KeyDown | Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement.) |
|
KeyUp | Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement.) |
|
LayoutUpdated | Occurs when the layout of the Silverlight visual tree changes. (Inherited from FrameworkElement.) |
|
Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement.) |
|
LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement.) |
|
LostMouseCapture | Occurs when the UIElement loses mouse capture. (Inherited from UIElement.) |
|
MediaCommand | Occurs when a button is pressed on a remote control. (Inherited from UIElement.) |
|
MouseEnter | Occurs when the mouse (or a stylus) enters the bounding area of a UIElement. (Inherited from UIElement.) |
|
MouseLeave | Occurs when the mouse (or the stylus) leaves the bounding area of a UIElement. (Inherited from UIElement.) |
|
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.) |
|
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.) |
|
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.) |
|
MouseRightButtonDown | Occurs when the right mouse button is pressed while the mouse pointer is over a UIElement. (Inherited from UIElement.) |
|
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.) |
|
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.) |
|
SelectionChanged | Occurs when the text selection has changed. |
|
SizeChanged | Occurs when either the ActualHeight or the ActualWidth properties change value on a FrameworkElement. (Inherited from FrameworkElement.) |
|
TextInput | Occurs when a UI element gets text in a device-independent manner. (Inherited from UIElement.) |
|
TextInputStart | Occurs when a UI element initially gets text in a device-independent manner. (Inherited from UIElement.) |
|
TextInputUpdate | Occurs when text continues to be composed via an input method editor (IME). (Inherited from UIElement.) |
|
Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") .gif "Static member") |
CharacterSpacingProperty | Identifies the CharacterSpacing dependency property. |
|
FontFamilyProperty | Identifies the FontFamily dependency property. |
|
FontSizeProperty | Identifies the FontSize dependency property. |
|
FontStretchProperty | Identifies the FontStretch dependency property. |
|
FontStyleProperty | Identifies the FontStyle dependency property. |
|
FontWeightProperty | Identifies the FontWeight dependency property. |
|
ForegroundProperty | Identifies the Foreground dependency property. |
|
HasOverflowContentProperty | Identifies the HasOverflowContent dependency property. |
|
IsTextSelectionEnabledProperty | Identifies the IsTextSelectionEnabled dependency property. |
|
LineHeightProperty | Identifies the LineHeight dependency property. |
|
LineStackingStrategyProperty | Identifies the LineStackingStrategy dependency property. |
|
OverflowContentTargetProperty | Identifies the OverflowContentTarget dependency property. |
|
PaddingProperty | Identifies the Padding dependency property. |
|
SelectedTextProperty | Identifies the SelectedText dependency property. |
|
TextAlignmentProperty | Identifies the TextAlignment dependency property. |
|
TextTrimmingProperty | Identifies the TextTrimming dependency property. |
|
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.