RichTextBlock class (Windows)

1 out of 7 rated this helpful - Rate this topic

Represents a rich text display container that supports formatted text, hyperlinks, inline images, and other rich content. RichTextBlock supports a built-in overflow model.

Inheritance

Object
DependencyObject
UIElement
FrameworkElement
RichTextBlock

Syntax

C++


public sealed class RichTextBlock : FrameworkElement

XAML Object Element Usage


<RichTextBlock .../>
-or-
<RichTextBlock ...>
  blocksContent
</RichTextBlock>

XAML Values

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

Attributes

ActivatableAttribute(NTDDI_WIN8)
ContentPropertyAttribute(Name=Blocks)
MarshalingBehaviorAttribute(Agile)
StaticAttribute(Windows.UI.Xaml.Controls.IRichTextBlockStatics, NTDDI_WIN8)
ThreadingAttribute(Both)
VersionAttribute(NTDDI_WIN8)
WebHostHiddenAttribute()

Members

The RichTextBlock class has these types of members:

Constructors
Events
Methods
Properties

Constructors

The RichTextBlock class has these constructors.

Constructor	Description
RichTextBlock	Initializes a new instance of the RichTextBlock class.

Events

The RichTextBlock class has these events.

Event	Description
ContextMenuOpening	Occurs when the system processes an interaction that displays a context menu.
DoubleTapped	Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element. (Inherited from UIElement)
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)
Holding	Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (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 visual tree changes. (Inherited from FrameworkElement)
Loaded	Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. (Inherited from FrameworkElement)
LostFocus	Occurs when a UIElement loses focus. (Inherited from UIElement)
ManipulationCompleted	Occurs when a manipulation on the UIElement is complete. (Inherited from UIElement)
ManipulationDelta	Occurs when the input device changes position during a manipulation. (Inherited from UIElement)
ManipulationInertiaStarting	Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Inherited from UIElement)
ManipulationStarted	Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement)
ManipulationStarting	Occurs when the manipulation processor is first created. (Inherited from UIElement)
PointerCanceled	Occurs when a pointer that made contact abnormally loses contact. (Inherited from UIElement)
PointerCaptureLost	Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Inherited from UIElement)
PointerEntered	Occurs when a pointer enters the hit test area of this element. (Inherited from UIElement)
PointerExited	Occurs when a pointer leaves the hit test area of this element. (Inherited from UIElement)
PointerMoved	Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Inherited from UIElement)
PointerPressed	Occurs when the pointer device initiates a Press action within this element. (Inherited from UIElement)
PointerReleased	Occurs when the pointer device that previously initiated a Press action is released, while within this element. (Inherited from UIElement)
PointerWheelChanged	Occurs when the delta value of a pointer wheel changes. (Inherited from UIElement)
RightTapped	Occurs when a right-tap input stimulus happens while the pointer is over the element. (Inherited from UIElement)
SelectionChanged	Occurs when the text selection has changed.
SizeChanged	Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Inherited from FrameworkElement)
Tapped	Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Inherited from UIElement)
Unloaded	Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement)

Methods

The RichTextBlock class has these methods. It also inherits methods from the Object class.

Method	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 even if the event is handled elsewhere. (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)
ArrangeOverride	Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement)
CapturePointer	Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement)
ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject)
FindName	Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement)
FindSubElementsForTouchTargeting	Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement)
Focus	Focuses the RichTextBlock, as if it were a conventionally focusable control.
GetAnimationBaseValue	Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetPositionFromPoint	Returns a TextPointer text reference from a RichTextBlock by hit-testing a specific Point within the text display area.
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 the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement)
OnApplyTemplate	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 your app. Override this method to influence the default post-template logic of a class. (Inherited from FrameworkElement)
OnCreateAutomationPeer	When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure. (Inherited from UIElement)
OnDisconnectVisualChildren	Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property. (Inherited from UIElement)
ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
ReleasePointerCapture	Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement)
ReleasePointerCaptures	Releases all pointer captures held by this element. (Inherited from UIElement)
RemoveHandler	Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement)
Select	Selects a range of text in the RichTextBlock.
SelectAll	Selects the entire contents in the RichTextBlock.
SetBinding	Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement)
SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
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)

Properties

The RichTextBlock class has these properties.

Property	Access type	Description
ActualHeight	Read-only	Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement)
ActualWidth	Read-only	Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement)
AllowDrop	Read/write	Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement)
BaselineOffset	Read-only	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.
BaseUri	Read-only	Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time. (Inherited from FrameworkElement)
Blocks	Read-only	Gets the contents of the RichTextBlock.
CacheMode	Read/write	Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)
CharacterSpacing	Read/write	Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.
CharacterSpacingProperty	Read-only	Identifies the CharacterSpacing dependency property.
Clip	Read/write	Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement)
ContentEnd	Read-only	Gets a TextPointer that indicates the end of content in the RichTextBlock.
ContentStart	Read-only	Gets a TextPointer that indicates the start of content in the RichTextBlock.
DataContext	Read/write	Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement)
DesiredSize	Read-only	Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement)
Dispatcher	Read-only	Gets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject)
FlowDirection	Read/write	Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left. (Inherited from FrameworkElement)
FontFamily	Read/write	Gets or sets the preferred top-level font family for the text content in this element.
FontFamilyProperty	Read-only	Identifies the FontFamily dependency property.
FontSize	Read/write	Gets or sets the font size for the text content in this element.
FontSizeProperty	Read-only	Identifies the FontSize dependency property.
FontStretch	Read/write	Gets or sets the font stretch for the text content in this element.
FontStretchProperty	Read-only	Identifies the FontStretch dependency property.
FontStyle	Read/write	Gets or sets the font style for the content in this element.
FontStyleProperty	Read-only	Identifies the FontStyle dependency property.
FontWeight	Read/write	Gets or sets the top-level font weight for the RichTextBlock.
FontWeightProperty	Read-only	Identifies the FontWeight dependency property.
Foreground	Read/write	Gets or sets the Brush to apply to the text contents of the RichTextBlock.
ForegroundProperty	Read-only	Identifies the Foreground dependency property.
HasOverflowContent	Read-only	Gets a value that indicates whether the RichTextBlock has content that extends beyond its bounds, that can provide content to an OverflowContentTarget element.
HasOverflowContentProperty	Read-only	Identifies the HasOverflowContent dependency property.
Height	Read/write	Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement)
HorizontalAlignment	Read/write	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)
IsDoubleTapEnabled	Read/write	Gets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement)
IsHitTestVisible	Read/write	Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement)
IsHoldingEnabled	Read/write	Gets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement)
IsRightTapEnabled	Read/write	Gets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement)
IsTapEnabled	Read/write	Gets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement)
IsTextSelectionEnabled	Read/write	Gets or sets a value that determines whether text content of the RichTextBlock can be selected for clipboard or drag purposes, or for UI styling changes that indicate selected text.
IsTextSelectionEnabledProperty	Read-only	Identifies the IsTextSelectionEnabled dependency property.
Language	Read/write	Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI. (Inherited from FrameworkElement)
LineHeight	Read/write	Gets or sets the height of each line of content.
LineHeightProperty	Read-only	Identifies the LineHeight dependency property.
LineStackingStrategy	Read/write	Gets or sets a value that indicates how a line box is determined for each line of text in the RichTextBlock.
LineStackingStrategyProperty	Read-only	Identifies the LineStackingStrategy dependency property.
ManipulationMode	Read/write	Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. (Inherited from UIElement)
Margin	Read/write	Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement)
MaxHeight	Read/write	Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement)
MaxWidth	Read/write	Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement)
MinHeight	Read/write	Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement)
MinWidth	Read/write	Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement)
Name	Read/write	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	Read/write	Gets or sets the degree of the object's opacity. (Inherited from UIElement)
OverflowContentTarget	Read/write	Gets or sets a reference to a RichTextBlockOverflow that is the linked target for any text overflow from this RichTextBlock.
OverflowContentTargetProperty	Read-only	Identifies the OverflowContentTarget dependency property.
Padding	Read/write	Gets or sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a RichTextBlock.
PaddingProperty	Read-only	Identifies the Padding dependency property.
Parent	Read-only	Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement)
PointerCaptures	Read-only	Gets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement)
Projection	Read/write	Gets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement)
RenderSize	Read-only	Gets the final render size of a UIElement. (Inherited from UIElement)
RenderTransform	Read/write	Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement)
RenderTransformOrigin	Read/write	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	Read/write	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	Read-only	Gets a text range of selected text.
SelectedTextProperty	Read-only	Identifies the SelectedText dependency property.
SelectionEnd	Read-only	Gets the end position of the text selected in the RichTextBlock.
SelectionStart	Read-only	Gets the starting position of the text selected in the RichTextBlock .
Style	Read/write	Gets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement)
Tag	Read/write	Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement)
TextAlignment	Read/write	Gets or sets a value that indicates how the text is aligned in the RichTextBlock.
TextAlignmentProperty	Read-only	Identifies the TextAlignment dependency property.
TextIndent	Read/write	Gets or sets the indentation of the first line of text in each paragraph in the RichTextBlock.
TextIndentProperty	Read-only	Identifies the TextIndent dependency property.
TextTrimming	Read/write	Gets or sets a value that indicates how text is trimmed when it overflows the content area.
TextTrimmingProperty	Read-only	Identifies the TextTrimming dependency property.
TextWrapping	Read/write	Gets or sets a value that indicates whether text wrapping occurs if a line of text extends beyond the available width of the RichTextBlock.
TextWrappingProperty	Read-only	Identifies the TextWrapping dependency property.
Transitions	Read/write	Gets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)
Triggers	Read-only	Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Inherited from FrameworkElement)
UseLayoutRounding	Read/write	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	Read/write	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	Read/write	Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout. (Inherited from UIElement)
Width	Read/write	Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement)

Remarks

RichTextBlock provides more advanced formatting features than the TextBlock control. You can apply character and paragraph formatting to the text in the RichTextBlock. For example, you can apply Bold, Italic, and Underline to any portion of the text in the control. The content property of RichTextBlock is the Blocks property, which is based on the Paragraph element. You can use the RichTextBlock to display text with UI elements that are derived from UIElement, such as images. You can do this by using the InlineUIContainer.

You can use a RichTextBlock with RichTextBlockOverflow elements to create advanced page layouts. The content for a RichTextBlockOverflow element always comes from a RichTextBlock element. You link RichTextBlockOverflow elements by setting them as the OverflowContentTarget of a RichTextBlock or another RichTextBlockOverflow.

Examples

Here, a RichTextBlock targets a RichTextBlockOverflow element to create a multi-column text layout. The first RichTextBlockOverflow element then targets a second RichTextBlockOverflow element that receives its content overflow. The controlling layout factor for how the text overflow is calculated is the constrained Width and Height of the parent Grid, and the ColumnDefinition settings that divide the Grid into three equal columns of 300 pixels height/width. Overflow is also affected by FontSize and many other text formatting properties that change characters in the text.

XAML


<Grid x:Name="columnGrid" Background="White" Width="900" Height="300">
    <Grid.ColumnDefinitions>
        <ColumnDefinition/>
        <ColumnDefinition/>
        <ColumnDefinition/>
    </Grid.ColumnDefinitions>
    <RichTextBlock Grid.Column="0" IsTextSelectionEnabled="True" TextAlignment="Justify" 
                   OverflowContentTarget="{Binding ElementName=firstOverflowContainer}" 
                   TextIndent="12"
                   FontSize="12" FontFamily="Segoe UI" Foreground="#2a2a2a" Margin="20,0">
        <Paragraph>
            <Bold><Span Foreground="DarkSlateBlue" FontSize="16">Lorem ipsum dolor sit amet</Span></Bold>, consectetur adipiscing elit. Sed ac mi ipsum. Phasellus vel malesuada mauris. Donec pharetra, enim sit amet mattis tincidunt, felis nisi semper lectus, vel porta diam nisi in augue. Pellentesque lacus tortor, aliquam et faucibus id, rhoncus ut justo. Sed id lectus odio, eget pulvinar diam. Suspendisse eleifend ornare libero, in luctus purus aliquet non. Sed interdum, sem vitae rutrum rhoncus, felis ligula ultrices sem, in eleifend eros ante id neque. Vivamus quam lorem, varius vitae porta mollis, placerat quis est. Aenean eget sagittis massa. Sed tellus turpis, ullamcorper eget imperdiet vel, faucibus vel nisl. Nunc sed suscipit quam. Vivamus convallis faucibus dignissim. Fusce sollicitudin, quam vel cursus mattis, nisl velit tristique sapien, ac vestibulum ante arcu a nisl. Vestibulum commodo gravida ante at tincidunt. Vestibulum in ornare nunc. Nullam ut lorem vitae dui placerat lacinia sit amet a arcu. Nulla sit amet odio nisi. Praesent erat urna, venenatis ac adipiscing vel, congue at lectus. Proin ac metus at quam luctus ultricies.
        </Paragraph>
        <Paragraph>
            <Italic>This is an inline image.</Italic>
            <InlineUIContainer>
                <Border Background="Black">
                    <Image Source="Assets/SmallLogo.png" Height="30" Width="30"/>
                </Border>
            </InlineUIContainer> 
            Nam vitae ligula non ligula suscipit semper. Duis sed nulla metus, id hendrerit velit. Curabitur dolor purus, bibendum eu cursus lacinia, interdum vel augue. Aenean euismod eros et sapien vehicula dictum. Duis ullamcorper, turpis nec feugiat tincidunt, dui erat luctus risus, aliquam accumsan lacus est vel quam. Nunc lacus massa, varius eget accumsan id, congue sed orci. Duis dignissim hendrerit egestas. Proin ut turpis magna, sit amet porta erat. Nunc semper metus nec magna imperdiet nec vestibulum dui fringilla. Sed sed ante libero, nec porttitor mi. Ut luctus, neque vitae placerat egestas, urna leo auctor magna, sit amet ultricies ipsum felis quis sapien. Proin eleifend varius dui, at vestibulum nunc consectetur nec. Mauris nulla elit, ultrices a sodales non, aliquam ac est. Quisque sit amet risus nulla. Quisque vestibulum posuere velit, vitae vestibulum eros scelerisque sit amet. In in risus est, at laoreet dolor. Nullam aliquet pellentesque convallis. Ut vel tincidunt nulla. Mauris auctor tincidunt auctor.
        </Paragraph>
    </RichTextBlock>
    <RichTextBlockOverflow x:Name="firstOverflowContainer" Grid.Column="1" Margin="20,0"
                           OverflowContentTarget="{Binding ElementName=secondOverflowContainer}"/>
    <RichTextBlockOverflow x:Name="secondOverflowContainer" Grid.Column="2" Margin="20,0"/>
</Grid>

For more examples, see scenario 4, "Linked text containers", of the XAML text display sample.

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Namespace	Windows.UI.Xaml.Controls Windows::UI::Xaml::Controls [C++]
Metadata	Windows.winmd

RichTextBlock class