RichTextBlock RichTextBlock RichTextBlock RichTextBlock Class

Definition

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

public : sealed class RichTextBlock : FrameworkElement, IRichTextBlock, IRichTextBlock2, IRichTextBlock3, IRichTextBlock4
public sealed class RichTextBlock : FrameworkElement, IRichTextBlock, IRichTextBlock2, IRichTextBlock3, IRichTextBlock4
Public NotInheritable Class RichTextBlock Inherits FrameworkElement Implements IRichTextBlock, IRichTextBlock2, IRichTextBlock3, IRichTextBlock4
var richTextBlock = new richTextBlock();
<RichTextBlock .../>
-or-
<RichTextBlock ...>
  blocksContent
</RichTextBlock>
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

This example shows a RichTextBlock with text selection and text wrapping enabled.

In XAML, the creation of content elements is implicit, so you can add the text directly to the Paragraph element, and the Paragraph directly to the RichTextBlock element.

In code, you have to explicitly create each Run element, set its Text property, and add it to the Paragraph.Inlines collection. Then, add each Paragraph to the RichTextBlock.Blocks collection.

<RichTextBlock IsTextSelectionEnabled="True" TextWrapping="Wrap" Width="200" >
    <Paragraph>
        This is some sample text to show the wrapping behavior.
    </Paragraph>
</RichTextBlock>
// Create a RichTextBlock, a Paragraph and a Run.
RichTextBlock richTextBlock = new RichTextBlock();
Paragraph paragraph = new Paragraph();
Run run = new Run();

// Customize some properties on the RichTextBlock.
richTextBlock.IsTextSelectionEnabled = true;
richTextBlock.TextWrapping = TextWrapping.Wrap;
run.Text = "This is some sample text to show the wrapping behavior.";
richTextBlock.Width = 200;

// Add the Run to the Paragraph, the Paragraph to the RichTextBlock.
paragraph.Inlines.Add(run);
richTextBlock.Blocks.Add(paragraph);

// Add the RichTextBlock to the visual tree (assumes stackPanel is decalred in XAML).
stackPanel.Children.Add(richTextBlock);

This example shows a RichTextBlock with customization of FontWeight, FontFamily, FontStyle, Foreground, and SelectionHighlightColor for a single run of text.

In XAML, the creation of content elements is implicit, so you can add the text directly to the Paragraph element, and the Paragraph directly to the RichTextBlock element.

In code, you have to explicitly create each Run element, set its Text property, and add it to the Paragraph.Inlines collection. Then, add each Paragraph to the RichTextBlock.Blocks collection.

<RichTextBlock IsTextSelectionEnabled="True" SelectionHighlightColor="Pink" 
               FontWeight="Light" FontFamily="Arial" FontStyle="Italic" 
               Foreground="Blue">
    <Paragraph>
        This is some sample text to demonstrate some properties.
    </Paragraph>
</RichTextBlock>
// Create a RichTextBlock, a Paragraph and a Run.
RichTextBlock richTextBlock = new RichTextBlock();
Paragraph paragraph = new Paragraph();
Run run = new Run();

// Customize some properties on the RichTextBlock.
richTextBlock.IsTextSelectionEnabled = true;
richTextBlock.SelectionHighlightColor = new SolidColorBrush(Windows.UI.Colors.Pink);
richTextBlock.Foreground = new SolidColorBrush(Windows.UI.Colors.Blue);
richTextBlock.FontWeight = Windows.UI.Text.FontWeights.Light;
richTextBlock.FontFamily = new FontFamily("Arial");
richTextBlock.FontStyle = Windows.UI.Text.FontStyle.Italic;
run.Text = "This is some sample text to demonstrate some properties.";

//Add the Run to the Paragraph, the Paragraph to the RichTextBlock.
paragraph.Inlines.Add(run);
richTextBlock.Blocks.Add(paragraph);

// Add the RichTextBlock to the visual tree (assumes stackPanel is decalred in XAML).
stackPanel.Children.Add(richTextBlock);

This example shows a RichTextBlock with customization of FontWeight, FontFamily, FontStyle, Foreground, and SelectionHighlightColor for different runs of text.

In XAML, the creation of content elements is implicit, so you can add the text directly to the Paragraph element, and the Paragraph directly to the RichTextBlock element.

In code, you have to explicitly create each Run element, set its Text property, and add it to the Paragraph.Inlines collection. Then, add each Paragraph to the RichTextBlock.Blocks collection.

<RichTextBlock IsTextSelectionEnabled="True" SelectionHighlightColor="Pink" FontFamily="Arial"  >
    <Paragraph>
        <Run Foreground="Blue" FontWeight="Light" Text="This is some" ></Run>
        <Span FontWeight="SemiBold">
            <Run FontStyle="Italic">sample text to</Run>
            <Run Foreground="Red">demonstrate some properties.</Run>
        </Span>
    </Paragraph>
</RichTextBlock>
RichTextBlock richTextBlock = new RichTextBlock();
richTextBlock.IsTextSelectionEnabled = true;
richTextBlock.SelectionHighlightColor = new SolidColorBrush(Windows.UI.Colors.Pink);
richTextBlock.FontFamily = new FontFamily("Arial");

Paragraph paragraph = new Paragraph();
Run run = new Run();
run.Foreground = new SolidColorBrush(Windows.UI.Colors.Blue);
run.FontWeight = Windows.UI.Text.FontWeights.Light;
run.Text = "This is some";

Span span = new Span();
span.FontWeight = Windows.UI.Text.FontWeights.SemiBold;

Run run1 = new Run();
run1.FontStyle = Windows.UI.Text.FontStyle.Italic;
run1.Text = " sample text to ";

Run run2 = new Run();
run2.Foreground = new SolidColorBrush(Windows.UI.Colors.Red);
run2.Text = " demonstrate some properties";

span.Inlines.Add(run1);
span.Inlines.Add(run2);
paragraph.Inlines.Add(run);
paragraph.Inlines.Add(span);
richTextBlock.Blocks.Add(paragraph);

// Add the RichTextBlock to the visual tree (assumes stackPanel is decalred in XAML).
stackPanel.Children.Add(richTextBlock);

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.

<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>

Remarks

The RichTextBlock control displays read-only text, and provides several features for advanced text layout. Use a RichTextBlock when you need support for paragraphs, inline UI elements, or overflow text.

TextBlock provides a simpler content model, so it’s typically easier to use, and it can provide better text rendering performance than RichTextBlock. It also provides many of the same formatting options for customizing how your text is rendered. However, RichTextBlock provides several unique features that TextBlock doesn’t provide.

For more info and examples, see the RichTextBlock control guide.

Paragraphs and formatting

The content property of RichTextBlock is the Blocks property, which is based on the Paragraph element. Set the indentation for paragraphs by setting the TextIndent property.

You can use text elements and the attached properties of the Typography class to 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.

Inline UI elements

You can use an InlineUIContainer in the content of a RichTextBlock to embed elements that are derived from UIElement, such as images, in your text.

Overflow content

You can use a RichTextBlock with RichTextBlockOverflow elements to create advanced page layouts, such as multi-column text. 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.

Font fallback

The default FontFamily for RichTextBlock is Segoe UI and the default FontSize is 15 device-independent pixel (DIP). By default, RichTextBlock utilizes a font fallback mechanism to show glyphs that are not included in the specified font. If the glyph that is needed in a RichTextBlock is not available in the specified font, the font fallback mechanism goes through a list of fonts on the system to try and display the required characters in a different font.

Constructors

RichTextBlock() RichTextBlock() RichTextBlock() RichTextBlock()

Initializes a new instance of the RichTextBlock class.

public : RichTextBlock()
public RichTextBlock()
Public Sub New()
var richTextBlock = new richTextBlock();

Properties

BaselineOffset BaselineOffset BaselineOffset 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 : double BaselineOffset { get; }
public double BaselineOffset { get; }
Public ReadOnly Property BaselineOffset As double
var double = richTextBlock.baselineOffset;
Value
double double double double

The computed baseline for the first paragraph, or 0 if the RichTextBlock is empty.

Blocks Blocks Blocks Blocks

Gets the contents of the RichTextBlock.

public : BlockCollection Blocks { get; }
public BlockCollection Blocks { get; }
Public ReadOnly Property Blocks As BlockCollection
var blockCollection = richTextBlock.blocks;
<RichTextBlock ...>
blocksContent
</RichTextBlock>

CharacterSpacing CharacterSpacing CharacterSpacing CharacterSpacing

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

public : int CharacterSpacing { get; set; }
public int CharacterSpacing { get; set; }
Public ReadWrite Property CharacterSpacing As int
var int = richTextBlock.characterSpacing;
richTextBlock.characterSpacing = int;
<RichTextBlock CharacterSpacing="int"/>
Value
int int int int

The uniform spacing between characters, in units of 1/1000 of an em. The default is 0. Positive values increase tracking and loosen character spacing. Negative values decrease tracking and tighten the character spacing.

Examples

To see an example, see scenario 1, "Tracking (character spacing)", of the XAML text display sample.

Remarks

Tracking is the typographic term for an amount of space added or removed between all pairs of characters in a portion of text. This feature can be accessed through the CharacterSpacing property on TextBlock and RichTextBlock. CharacterSpacing is measured in 1/1000 of an "em". One "em" is equivalent to the current font size of the control. For example, an additional 14 pixels will be inserted between each character in a text control with FontSize="14" and CharacterSpacing="1000".

See Also

CharacterSpacingProperty CharacterSpacingProperty CharacterSpacingProperty CharacterSpacingProperty

Identifies the CharacterSpacing dependency property.

public : static DependencyProperty CharacterSpacingProperty { get; }
public static DependencyProperty CharacterSpacingProperty { get; }
Public Static ReadOnly Property CharacterSpacingProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.characterSpacingProperty;

ContentEnd ContentEnd ContentEnd ContentEnd

Gets a TextPointer that indicates the end of content in the RichTextBlock.

public : TextPointer ContentEnd { get; }
public TextPointer ContentEnd { get; }
Public ReadOnly Property ContentEnd As TextPointer
var textPointer = richTextBlock.contentEnd;
Value
TextPointer TextPointer TextPointer TextPointer

A TextPointer that indicates the end of content in the RichTextBlock.

ContentStart ContentStart ContentStart ContentStart

Gets a TextPointer that indicates the start of content in the RichTextBlock.

public : TextPointer ContentStart { get; }
public TextPointer ContentStart { get; }
Public ReadOnly Property ContentStart As TextPointer
var textPointer = richTextBlock.contentStart;
Value
TextPointer TextPointer TextPointer TextPointer

A TextPointer that indicates the start of content in the RichTextBlock.

FontFamily FontFamily FontFamily FontFamily

Gets or sets the preferred top-level font family for the text content in this element.

public : FontFamily FontFamily { get; set; }
public FontFamily FontFamily { get; set; }
Public ReadWrite Property FontFamily As FontFamily
var fontFamily = richTextBlock.fontFamily;
richTextBlock.fontFamily = fontFamily;
<RichTextBlock FontFamily="fontFamily" />
-or-
<RichTextBlock FontFamily="fontFamilyName[,fallbackFontFamilyName]" />
-or-
<RichTextBlock FontFamily="fontURI#fontFamily" />
Value
FontFamily FontFamily FontFamily FontFamily

A FontFamily object that specifies the preferred font family, or a primary preferred font family with one or more fallback font families. For information about defaults, see the FontFamily class topic.

Remarks

Set the FontFamily property to specify the default font family to use for all text in the RichTextBlock. You can override this value for specific text elements in the RichTextBlock by setting the TextElement.FontFamily property.

FontFamilyProperty FontFamilyProperty FontFamilyProperty FontFamilyProperty

Identifies the FontFamily dependency property.

public : static DependencyProperty FontFamilyProperty { get; }
public static DependencyProperty FontFamilyProperty { get; }
Public Static ReadOnly Property FontFamilyProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.fontFamilyProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the FontFamily dependency property.

FontSize FontSize FontSize FontSize

Gets or sets the font size for the text content in this element.

public : double FontSize { get; set; }
public double FontSize { get; set; }
Public ReadWrite Property FontSize As double
var double = richTextBlock.fontSize;
richTextBlock.fontSize = double;
<RichTextBlock FontSize="double" .../>
Value
double double double double

A non-negative value that specifies the font size, measured in pixels. The default is 11.

Remarks

Set the FontSize property to specify the default font size to use for all text in the RichTextBlock. You can override this value for specific text elements in the RichTextBlock by setting the TextElement.FontSize property.

FontSizeProperty FontSizeProperty FontSizeProperty FontSizeProperty

Identifies the FontSize dependency property.

public : static DependencyProperty FontSizeProperty { get; }
public static DependencyProperty FontSizeProperty { get; }
Public Static ReadOnly Property FontSizeProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.fontSizeProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the FontSize dependency property.

FontStretch FontStretch FontStretch FontStretch

Gets or sets the font stretch for the text content in this element.

public : FontStretch FontStretch { get; set; }
public FontStretch FontStretch { get; set; }
Public ReadWrite Property FontStretch As FontStretch
var fontStretch = richTextBlock.fontStretch;
richTextBlock.fontStretch = fontStretch;
<RichTextBlock FontStretch="fontStretchMemberName"/>
Value
FontStretch FontStretch FontStretch FontStretch

The requested font stretch, as a FontStretch constant. The default is Normal.

Remarks

Set the FontStretch property to specify the default font stretch to use for all text in the RichTextBlock. You can override this value for specific text elements in the RichTextBlock by setting the TextElement.FontStretch property.

FontStretchProperty FontStretchProperty FontStretchProperty FontStretchProperty

Identifies the FontStretch dependency property.

public : static DependencyProperty FontStretchProperty { get; }
public static DependencyProperty FontStretchProperty { get; }
Public Static ReadOnly Property FontStretchProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.fontStretchProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the FontStretch dependency property.

FontStyle FontStyle FontStyle FontStyle

Gets or sets the font style for the content in this element.

public : FontStyle FontStyle { get; set; }
public FontStyle FontStyle { get; set; }
Public ReadWrite Property FontStyle As FontStyle
var fontStyle = richTextBlock.fontStyle;
richTextBlock.fontStyle = fontStyle;
<RichTextBlock FontStyle="fontStyleMemberName"/>
Value
FontStyle FontStyle FontStyle FontStyle

The requested font style, which is a FontStyle enumeration named constant. The default is Normal.

Remarks

Set the FontStyle property to specify the default font stretch to use for all text in the RichTextBlock. You can override this value for specific text elements in the RichTextBlock by setting the TextElement.FontStyle property.

FontStyleProperty FontStyleProperty FontStyleProperty FontStyleProperty

Identifies the FontStyle dependency property.

public : static DependencyProperty FontStyleProperty { get; }
public static DependencyProperty FontStyleProperty { get; }
Public Static ReadOnly Property FontStyleProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.fontStyleProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the FontStyle dependency property.

FontWeight FontWeight FontWeight FontWeight

Gets or sets the top-level font weight for the RichTextBlock.

public : FontWeight FontWeight { get; set; }
public FontWeight FontWeight { get; set; }
Public ReadWrite Property FontWeight As FontWeight
var fontWeight = richTextBlock.fontWeight;
richTextBlock.fontWeight = fontWeight;
<RichTextBlock FontWeight="fontWeightsMemberName"/>
Value
FontWeight FontWeight FontWeight FontWeight

The requested font weight, which is a FontWeight that is obtained from one of the FontWeights property values. The default is Normal.

Remarks

Set the FontWeight property to specify the default font stretch to use for all text in the RichTextBlock. You can override this value for specific text elements in the RichTextBlock by setting the TextElement.FontWeight property.

FontWeightProperty FontWeightProperty FontWeightProperty FontWeightProperty

Identifies the FontWeight dependency property.

public : static DependencyProperty FontWeightProperty { get; }
public static DependencyProperty FontWeightProperty { get; }
Public Static ReadOnly Property FontWeightProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.fontWeightProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the FontWeight dependency property.

Foreground Foreground Foreground Foreground

Gets or sets the Brush to apply to the text contents of the RichTextBlock.

public : Brush Foreground { get; set; }
public Brush Foreground { get; set; }
Public ReadWrite Property Foreground As Brush
var brush = richTextBlock.foreground;
richTextBlock.foreground = brush;
<RichTextBlock Foreground="{StaticResource resourceName}"/>

Value
Brush Brush Brush Brush

The brush used to apply to the text contents. The default is a null brush from a pure code perspective, but the default text styles set this to Black (for Light theme) or White (for Dark theme) for a TextBlock element in UI.

Remarks

Set the Foreground property to specify the default brush to use for all text in the RichTextBlock. You can override this value for specific text elements (such as a Run ) in the RichTextBlock by setting the TextElement.Foreground property.

The default appearance of text and text styles depends heavily on the active theme and other settings. The theme and various styles and behaviors that are using default system settings or user preferences are the source of the effective runtime appearance of RichTextBlock foreground color of text as well as other text characteristics. You can change these defaults by changing the property values, or by applying a different style to specific RichTextBlock instances. You can change the foreground value for all default text by overriding the resource named DefaultTextForegroundThemeBrush in App.xaml.

See Also

ForegroundProperty ForegroundProperty ForegroundProperty ForegroundProperty

Identifies the Foreground dependency property.

public : static DependencyProperty ForegroundProperty { get; }
public static DependencyProperty ForegroundProperty { get; }
Public Static ReadOnly Property ForegroundProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.foregroundProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the Foreground dependency property.

HasOverflowContent HasOverflowContent HasOverflowContent HasOverflowContent

Gets a value that indicates whether the RichTextBlock has content that extends beyond its bounds, that can provide content to an OverflowContentTarget element.

public : Platform::Boolean HasOverflowContent { get; }
public bool HasOverflowContent { get; }
Public ReadOnly Property HasOverflowContent As bool
var bool = richTextBlock.hasOverflowContent;
Value
Platform::Boolean bool bool bool

True if the RichTextBlock has content that extends beyond its bounds; otherwise, false.

Remarks

If HasOverflowContent is true and the OverflowContentTarget property is set, the extra content flows into the OverflowContentTarget element.

See Also

HasOverflowContentProperty HasOverflowContentProperty HasOverflowContentProperty HasOverflowContentProperty

Identifies the HasOverflowContent dependency property.

public : static DependencyProperty HasOverflowContentProperty { get; }
public static DependencyProperty HasOverflowContentProperty { get; }
Public Static ReadOnly Property HasOverflowContentProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.hasOverflowContentProperty;

HorizontalTextAlignment HorizontalTextAlignment HorizontalTextAlignment HorizontalTextAlignment

Gets or sets a value that indicates how text is aligned in the RichTextBlock.

public : TextAlignment HorizontalTextAlignment { get; set; }
public TextAlignment HorizontalTextAlignment { get; set; }
Public ReadWrite Property HorizontalTextAlignment As TextAlignment
var textAlignment = richTextBlock.horizontalTextAlignment;
richTextBlock.horizontalTextAlignment = textAlignment;
<RichTextBlock HorizontalTextAlignment="textAlignmentValue"/>

Value
TextAlignment TextAlignment TextAlignment TextAlignment

One of the TextAlignment enumeration values that specifies how text is aligned. The default is Left.

Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

This property provides the same functionality as the TextAlignment property. If both properties are set to conflicting values, the last one set is used.

Apps that target the Fall Creators Update (SDK 16299) or later should use this property instead of TextAlignment. If your app also supports previous versions, see Version adaptive apps: Use new APIs while maintaining compatibility with previous versions for more info.

HorizontalTextAlignmentProperty HorizontalTextAlignmentProperty HorizontalTextAlignmentProperty HorizontalTextAlignmentProperty

Identifies the HorizontalTextAlignment dependency property.

public : static DependencyProperty HorizontalTextAlignmentProperty { get; }
public static DependencyProperty HorizontalTextAlignmentProperty { get; }
Public Static ReadOnly Property HorizontalTextAlignmentProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.horizontalTextAlignmentProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the HorizontalTextAlignment dependency property.

Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

IsColorFontEnabled IsColorFontEnabled IsColorFontEnabled IsColorFontEnabled

Gets or sets a value that determines whether font glyphs that contain color layers, such as Segoe UI Emoji, are rendered in color.

public : Platform::Boolean IsColorFontEnabled { get; set; }
public bool IsColorFontEnabled { get; set; }
Public ReadWrite Property IsColorFontEnabled As bool
var bool = richTextBlock.isColorFontEnabled;
richTextBlock.isColorFontEnabled = bool;
<RichEditBlock IsColorFontEnabled="bool" />
Value
Platform::Boolean bool bool bool

true if color glyphs show in color; otherwise, false. The default is true.

Remarks

Windows 8.1 introduces the ability for fonts to include multiple colored layers for each glyph. For example, the Segoe UI Emoji font defines color versions of the Emoticon and other Emoji characters. By default, the IsColorFontEnabled property is true and fonts with these additional layers are rendered in color.

In Windows 8, Extensible Application Markup Language (XAML) text controls don't render multi-color fonts in color. When an app that was compiled for Windows 8 is recompiled for Windows 8.1, color rendering of multi-color fonts is enabled by default. Some glyphs in multi-color fonts have different layout metrics when rendered in color. This could cause different layout in apps when they are recompiled for Windows 8.1. To retain the Windows 8 behavior when your app is recompiled for Windows 8.1, set IsColorFontEnabled to false.

IsColorFontEnabledProperty IsColorFontEnabledProperty IsColorFontEnabledProperty IsColorFontEnabledProperty

Identifies the IsColorFontEnabled dependency property.

public : static DependencyProperty IsColorFontEnabledProperty { get; }
public static DependencyProperty IsColorFontEnabledProperty { get; }
Public Static ReadOnly Property IsColorFontEnabledProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.isColorFontEnabledProperty;

IsTextScaleFactorEnabled IsTextScaleFactorEnabled IsTextScaleFactorEnabled IsTextScaleFactorEnabled

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

public : Platform::Boolean IsTextScaleFactorEnabled { get; set; }
public bool IsTextScaleFactorEnabled { get; set; }
Public ReadWrite Property IsTextScaleFactorEnabled As bool
var bool = richTextBlock.isTextScaleFactorEnabled;
richTextBlock.isTextScaleFactorEnabled = bool;
<RichTextBlock IsTextScaleFactorEnabled="bool"/>
Value
Platform::Boolean bool bool bool

true if automatic text enlargement is enabled; otherwise, false.

See Also

IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty

Identifies the IsTextScaleFactorEnabled dependency property.

public : static DependencyProperty IsTextScaleFactorEnabledProperty { get; }
public static DependencyProperty IsTextScaleFactorEnabledProperty { get; }
Public Static ReadOnly Property IsTextScaleFactorEnabledProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.isTextScaleFactorEnabledProperty;

IsTextSelectionEnabled IsTextSelectionEnabled IsTextSelectionEnabled IsTextSelectionEnabled

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.

public : Platform::Boolean IsTextSelectionEnabled { get; set; }
public bool IsTextSelectionEnabled { get; set; }
Public ReadWrite Property IsTextSelectionEnabled As bool
var bool = richTextBlock.isTextSelectionEnabled;
richTextBlock.isTextSelectionEnabled = bool;
<RichTextBlock IsTextSelectionEnabled="bool" />
Value
Platform::Boolean bool bool bool

true if text content of the RichTextBlock can be selected for clipboard or drag purposes. false if text cannot be selected. The default is true.

IsTextSelectionEnabledProperty IsTextSelectionEnabledProperty IsTextSelectionEnabledProperty IsTextSelectionEnabledProperty

Identifies the IsTextSelectionEnabled dependency property.

public : static DependencyProperty IsTextSelectionEnabledProperty { get; }
public static DependencyProperty IsTextSelectionEnabledProperty { get; }
Public Static ReadOnly Property IsTextSelectionEnabledProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.isTextSelectionEnabledProperty;

IsTextTrimmed IsTextTrimmed IsTextTrimmed IsTextTrimmed

Gets a value that indicates whether the control has trimmed text that overflows the content area.

public : Platform::Boolean IsTextTrimmed { get; }
public bool IsTextTrimmed { get; }
Public ReadOnly Property IsTextTrimmed As bool
var bool = richTextBlock.isTextTrimmed;
Value
Platform::Boolean bool bool bool

true if text is trimmed; otherwise, false.

Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

See the TextTrimming property and TextTrimming enumeration for more info about how text is trimmed.

IsTextTrimmedProperty IsTextTrimmedProperty IsTextTrimmedProperty IsTextTrimmedProperty

Identifies the IsTextTrimmed dependency property.

public : static DependencyProperty IsTextTrimmedProperty { get; }
public static DependencyProperty IsTextTrimmedProperty { get; }
Public Static ReadOnly Property IsTextTrimmedProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.isTextTrimmedProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the IsTextTrimmed dependency property.

Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

LineHeight LineHeight LineHeight LineHeight

Gets or sets the height of each line of content.

public : double LineHeight { get; set; }
public double LineHeight { get; set; }
Public ReadWrite Property LineHeight As double
var double = richTextBlock.lineHeight;
richTextBlock.lineHeight = double;
<RichTextBlock LineHeight="double"/>
Value
double double double double

The height of each line in pixels. A value of 0 indicates that the line height is determined automatically from the current font characteristics. The default is 0.

LineHeightProperty LineHeightProperty LineHeightProperty LineHeightProperty

Identifies the LineHeight dependency property.

public : static DependencyProperty LineHeightProperty { get; }
public static DependencyProperty LineHeightProperty { get; }
Public Static ReadOnly Property LineHeightProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.lineHeightProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the LineHeight dependency property.

LineStackingStrategy LineStackingStrategy LineStackingStrategy LineStackingStrategy

Gets or sets a value that indicates how a line box is determined for each line of text in the RichTextBlock.

public : LineStackingStrategy LineStackingStrategy { get; set; }
public LineStackingStrategy LineStackingStrategy { get; set; }
Public ReadWrite Property LineStackingStrategy As LineStackingStrategy
var lineStackingStrategy = richTextBlock.lineStackingStrategy;
richTextBlock.lineStackingStrategy = lineStackingStrategy;
<RichTextBlock LineStackingStrategy="BlockLineHeight"/>
-or-
<RichTextBlock LineStackingStrategy="MaxHeight"/>
Value
LineStackingStrategy LineStackingStrategy LineStackingStrategy LineStackingStrategy

A value that indicates how a line box is determined for each line of text in the RichTextBlock. The default is MaxHeight.

LineStackingStrategyProperty LineStackingStrategyProperty LineStackingStrategyProperty LineStackingStrategyProperty

Identifies the LineStackingStrategy dependency property.

public : static DependencyProperty LineStackingStrategyProperty { get; }
public static DependencyProperty LineStackingStrategyProperty { get; }
Public Static ReadOnly Property LineStackingStrategyProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.lineStackingStrategyProperty;

MaxLines MaxLines MaxLines MaxLines

Gets or sets the maximum lines of text shown in the RichTextBlock.

public : int MaxLines { get; set; }
public int MaxLines { get; set; }
Public ReadWrite Property MaxLines As int
var int = richTextBlock.maxLines;
richTextBlock.maxLines = int;
<RichTextBlock MaxLines="int"/>
Value
int int int int

The maximum lines of text shown in the RichTextBlock. The default is 0, which is a special value that represents "Auto" behavior. The value cannot be negative.

Remarks

Use the MaxLines property to specify the maximum lines of text shown in a text block. The text control will adjust it’s height to show no more than the specified number of lines, regardless of the font size, font style, or text length.

Negative integer values are invalid, and will cause a run-time exception.

MaxLinesProperty MaxLinesProperty MaxLinesProperty MaxLinesProperty

Identifies the MaxLines dependency property.

public : static DependencyProperty MaxLinesProperty { get; }
public static DependencyProperty MaxLinesProperty { get; }
Public Static ReadOnly Property MaxLinesProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.maxLinesProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the MaxLines dependency property.

OpticalMarginAlignment OpticalMarginAlignment OpticalMarginAlignment OpticalMarginAlignment

Get or sets a value that indicates how the font is modified to align with fonts of different sizes.

public : OpticalMarginAlignment OpticalMarginAlignment { get; set; }
public OpticalMarginAlignment OpticalMarginAlignment { get; set; }
Public ReadWrite Property OpticalMarginAlignment As OpticalMarginAlignment
var opticalMarginAlignment = richTextBlock.opticalMarginAlignment;
richTextBlock.opticalMarginAlignment = opticalMarginAlignment;
<RichTextBlock OpticalMarginAlignment="None"/>
-or-
<RichTextBlock OpticalMarginAlignment="TrimSideBearings"/>
Value
OpticalMarginAlignment OpticalMarginAlignment OpticalMarginAlignment OpticalMarginAlignment

A value of the enumeration that indicates how the font is modified to align at different sizes. The default is None.

Remarks

When OpticalMarginAlignment is set to TrimSideBearings, the text is trimmed to the leftmost stroke of the first character and the rightmost stroke of the last character on a line. For example, an "L" has a small amount of space to the left of the vertical stroke, which scales with font size. When TrimSideBearings is set, the left of the vertical stroke is directly aligned without the spacing. This enables easier alignment to the Windows grid system as explained in Laying out an app page.

OpticalMarginAlignmentProperty OpticalMarginAlignmentProperty OpticalMarginAlignmentProperty OpticalMarginAlignmentProperty

Identifies the OpticalMarginAlignment dependency property.

public : static DependencyProperty OpticalMarginAlignmentProperty { get; }
public static DependencyProperty OpticalMarginAlignmentProperty { get; }
Public Static ReadOnly Property OpticalMarginAlignmentProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.opticalMarginAlignmentProperty;

OverflowContentTarget OverflowContentTarget OverflowContentTarget OverflowContentTarget

Gets or sets a reference to a RichTextBlockOverflow that is the linked target for any text overflow from this RichTextBlock.

public : RichTextBlockOverflow OverflowContentTarget { get; set; }
public RichTextBlockOverflow OverflowContentTarget { get; set; }
Public ReadWrite Property OverflowContentTarget As RichTextBlockOverflow
var richTextBlockOverflow = richTextBlock.overflowContentTarget;
richTextBlock.overflowContentTarget = richTextBlockOverflow;
RichTextBlock OverflowContentTarget="{Binding ElementName=nameOfTarget}" />
See Also

OverflowContentTargetProperty OverflowContentTargetProperty OverflowContentTargetProperty OverflowContentTargetProperty

Identifies the OverflowContentTarget dependency property.

public : static DependencyProperty OverflowContentTargetProperty { get; }
public static DependencyProperty OverflowContentTargetProperty { get; }
Public Static ReadOnly Property OverflowContentTargetProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.overflowContentTargetProperty;

Padding Padding Padding Padding

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.

public : Thickness Padding { get; set; }
public Thickness Padding { get; set; }
Public ReadWrite Property Padding As Thickness
var thickness = richTextBlock.padding;
richTextBlock.padding = thickness;
<RichTextBlock Padding="uniform"/>
- or -
<RichTextBlock Padding="left&Right,top&Bottom"/>
- or -
<RichTextBlock Padding="left,top,right,bottom"/>
Value
Thickness Thickness Thickness Thickness

A Thickness structure that specifies the amount of padding to apply.

Remarks

A related property is Margin (a property of FrameworkElement ). For more info about the relationship between margin and padding, see Alignment, margin, and padding or Define layouts with XAML.

See Also

PaddingProperty PaddingProperty PaddingProperty PaddingProperty

Identifies the Padding dependency property.

public : static DependencyProperty PaddingProperty { get; }
public static DependencyProperty PaddingProperty { get; }
Public Static ReadOnly Property PaddingProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.paddingProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the Padding dependency property.

SelectedText SelectedText SelectedText SelectedText

Gets a text range of selected text.

public : Platform::String SelectedText { get; }
public string SelectedText { get; }
Public ReadOnly Property SelectedText As string
var string = richTextBlock.selectedText;
Value
Platform::String string string string

A text range of the selected text.

SelectedTextProperty SelectedTextProperty SelectedTextProperty SelectedTextProperty

Identifies the SelectedText dependency property.

public : static DependencyProperty SelectedTextProperty { get; }
public static DependencyProperty SelectedTextProperty { get; }
Public Static ReadOnly Property SelectedTextProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.selectedTextProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the SelectedText dependency property.

SelectionEnd SelectionEnd SelectionEnd SelectionEnd

Gets the end position of the text selected in the RichTextBlock.

public : TextPointer SelectionEnd { get; }
public TextPointer SelectionEnd { get; }
Public ReadOnly Property SelectionEnd As TextPointer
var textPointer = richTextBlock.selectionEnd;
Value
TextPointer TextPointer TextPointer TextPointer

An object that represents the selection end, or null if no selection exists.

Remarks

Use Select to set the selection start and end.

SelectionHighlightColor SelectionHighlightColor SelectionHighlightColor SelectionHighlightColor

Gets or sets the brush used to highlight the selected text.

public : SolidColorBrush SelectionHighlightColor { get; set; }
public SolidColorBrush SelectionHighlightColor { get; set; }
Public ReadWrite Property SelectionHighlightColor As SolidColorBrush
var solidColorBrush = richTextBlock.selectionHighlightColor;
richTextBlock.selectionHighlightColor = solidColorBrush;
<RichTextBlock SelectionHighlightColor="{StaticResource resourceName}"/>

Value
SolidColorBrush SolidColorBrush SolidColorBrush SolidColorBrush

The brush used to highlight the selected text. The default is a null brush from a pure code perspective, but the default text styles for RichTextBlock content apply a theme resource brush for this in a runtime instance of a RichTextBlock control.

Remarks

A default text style sets the default selection highlight color to the system resource TextSelectionHighlightColorThemeBrush. To change the selection highlight color for all editable text controls in your app, you can override the TextSelectionHighlightColorThemeBrush system resource in App.xaml. This will affect PasswordBox, TextBox, and RichEditBox controls as well as RichTextBlock content. For more info, see XAML theme resources.

See Also

SelectionHighlightColorProperty SelectionHighlightColorProperty SelectionHighlightColorProperty SelectionHighlightColorProperty

Identifies the SelectionHighlightColor dependency property.

public : static DependencyProperty SelectionHighlightColorProperty { get; }
public static DependencyProperty SelectionHighlightColorProperty { get; }
Public Static ReadOnly Property SelectionHighlightColorProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.selectionHighlightColorProperty;

SelectionStart SelectionStart SelectionStart SelectionStart

Gets the starting position of the text selected in the RichTextBlock.

public : TextPointer SelectionStart { get; }
public TextPointer SelectionStart { get; }
Public ReadOnly Property SelectionStart As TextPointer
var textPointer = richTextBlock.selectionStart;
Value
TextPointer TextPointer TextPointer TextPointer

An object that represents the selection start, or null if no selection exists.

Remarks

Use Select to set the selection start and end.

TextAlignment TextAlignment TextAlignment TextAlignment

Gets or sets a value that indicates how the text is aligned in the RichTextBlock.

public : TextAlignment TextAlignment { get; set; }
public TextAlignment TextAlignment { get; set; }
Public ReadWrite Property TextAlignment As TextAlignment
var textAlignment = richTextBlock.textAlignment;
richTextBlock.textAlignment = textAlignment;
<RichTextBlock TextAlignment="textAlignmentValue"/>
Value
TextAlignment TextAlignment TextAlignment TextAlignment

One of the TextAlignment enumeration values that indicates how text is aligned. The default is Left.

TextAlignmentProperty TextAlignmentProperty TextAlignmentProperty TextAlignmentProperty

Identifies the TextAlignment dependency property.

public : static DependencyProperty TextAlignmentProperty { get; }
public static DependencyProperty TextAlignmentProperty { get; }
Public Static ReadOnly Property TextAlignmentProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.textAlignmentProperty;

TextDecorations TextDecorations TextDecorations TextDecorations

Gets or sets a value that indicates what decorations are applied to the text.

public : TextDecorations TextDecorations { get; set; }
public TextDecorations TextDecorations { get; set; }
Public ReadWrite Property TextDecorations As TextDecorations
var textDecorations = richTextBlock.textDecorations;
richTextBlock.textDecorations = textDecorations;
<RichTextBlock TextDecorations="textDecorationsMemberName"/>
Value
TextDecorations TextDecorations TextDecorations TextDecorations

A value of the enumeration. The default is None.

Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Examples

This example shows how to apply text decorations to text in a RichTextBlock, both at the control level and at the TextElement level.

<RichTextBlock TextDecorations="Underline"
            Loaded="RichTextBlock_Loaded">
    <Paragraph>This text has an underline.</Paragraph>
    <Paragraph TextDecorations="Strikethrough">
        This text has a strikethrough, but no underline.
    </Paragraph>
    <Paragraph TextDecorations="Strikethrough, Underline">This text has it all!</Paragraph>
    <Paragraph x:Name="Paragraph4">This text is decorated in code.</Paragraph>
</RichTextBlock>
private void RichTextBlock_Loaded(object sender, RoutedEventArgs e)
{
    // Apply both strikethough and underline to the last paragraph.
    Paragraph4.TextDecorations =
        TextDecorations.Strikethrough | TextDecorations.Underline;
}

Remarks

Starting with the Windows 10 Creators Update (SDK version 15063), this property is the preferred way to strikethrough or underline text.

For earlier versions of Windows, you can underline text with the Underline class.

TextDecorationsProperty TextDecorationsProperty TextDecorationsProperty TextDecorationsProperty

Identifies the TextDecorations dependency property.

public : static DependencyProperty TextDecorationsProperty { get; }
public static DependencyProperty TextDecorationsProperty { get; }
Public Static ReadOnly Property TextDecorationsProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.textDecorationsProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the TextDecorations dependency property.

Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

TextHighlighters TextHighlighters TextHighlighters TextHighlighters

Gets the collection of text highlights.

public : IVector<TextHighlighter> TextHighlighters { get; }
public IList<TextHighlighter> TextHighlighters { get; }
Public ReadOnly Property TextHighlighters As IList<TextHighlighter>
var iList = richTextBlock.textHighlighters;
Value
IVector<TextHighlighter> IList<TextHighlighter> IList<TextHighlighter> IList<TextHighlighter>

The collection of text highlights.

Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

TextIndent TextIndent TextIndent TextIndent

Gets or sets the indentation of the first line of text in each paragraph in the RichTextBlock.

public : double TextIndent { get; set; }
public double TextIndent { get; set; }
Public ReadWrite Property TextIndent As double
var double = richTextBlock.textIndent;
richTextBlock.textIndent = double;
<RichTextBlock TextIndent="double"/>
Value
double double double double

The offset amount of the first line of text in a paragraph.

Remarks

You can override this setting for specific paragraphs in a RichTextBlock by setting the Paragraph.TextIndent property to a different value.

TextIndentProperty TextIndentProperty TextIndentProperty TextIndentProperty

Identifies the TextIndent dependency property.

public : static DependencyProperty TextIndentProperty { get; }
public static DependencyProperty TextIndentProperty { get; }
Public Static ReadOnly Property TextIndentProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.textIndentProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier of the TextIndent dependency property.

TextLineBounds TextLineBounds TextLineBounds TextLineBounds

Gets or sets a value that indicates how the line box height is determined for each line of text in the RichTextBlock.

public : TextLineBounds TextLineBounds { get; set; }
public TextLineBounds TextLineBounds { get; set; }
Public ReadWrite Property TextLineBounds As TextLineBounds
var textLineBounds = richTextBlock.textLineBounds;
richTextBlock.textLineBounds = textLineBounds;
<RichTextBlock TextLineBounds="textLineBoundsValue"/>
Value
TextLineBounds TextLineBounds TextLineBounds TextLineBounds

A value that indicates how the line box height is determined for each line of text in the RichTextBlock. The default is Full.

Remarks

For illustrations of how the different values for TextLineBounds affect adjacent lines of text, see TextLineBounds.

TextLineBoundsProperty TextLineBoundsProperty TextLineBoundsProperty TextLineBoundsProperty

Identifies the TextLineBounds dependency property.

public : static DependencyProperty TextLineBoundsProperty { get; }
public static DependencyProperty TextLineBoundsProperty { get; }
Public Static ReadOnly Property TextLineBoundsProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.textLineBoundsProperty;

TextReadingOrder TextReadingOrder TextReadingOrder TextReadingOrder

Gets or sets a value that indicates how the reading order is determined for the RichTextBlock.

public : TextReadingOrder TextReadingOrder { get; set; }
public TextReadingOrder TextReadingOrder { get; set; }
Public ReadWrite Property TextReadingOrder As TextReadingOrder
var textReadingOrder = richTextBlock.textReadingOrder;
richTextBlock.textReadingOrder = textReadingOrder;
<RichTextBlock TextReadingOrder="textReadingOrderValue"/>
Value
TextReadingOrder TextReadingOrder TextReadingOrder TextReadingOrder

A value that indicates how the reading order is determined for the RichTextBlock. The default is DetectFromContent.

Remarks

This property can be useful when the base direction of the text is unknown, and may not match the user's language or direction. For more info, see the Remarks section of the TextReadingOrder enumeration or How to support bidirectional UI.

Note

In Windows 8.1, the default value is 0, Default. Starting with Windows 10, the enumeration value 0 has the constant name UseFlowDirection, and is not the default value.

See Also

TextReadingOrderProperty TextReadingOrderProperty TextReadingOrderProperty TextReadingOrderProperty

Identifies the TextReadingOrder dependency property.

public : static DependencyProperty TextReadingOrderProperty { get; }
public static DependencyProperty TextReadingOrderProperty { get; }
Public Static ReadOnly Property TextReadingOrderProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.textReadingOrderProperty;

TextTrimming TextTrimming TextTrimming TextTrimming

Gets or sets a value that indicates how text is trimmed when it overflows the content area.

public : TextTrimming TextTrimming { get; set; }
public TextTrimming TextTrimming { get; set; }
Public ReadWrite Property TextTrimming As TextTrimming
var textTrimming = richTextBlock.textTrimming;
richTextBlock.textTrimming = textTrimming;
<RichTextBlock TextTrimming="None"/>
-or-
<RichTextBlock TextTrimming="WordEllipsis"/>
Value
TextTrimming TextTrimming TextTrimming TextTrimming

One of the TextTrimming enumeration values that specifies the text trimming behavior to use. The default is None.

TextTrimmingProperty TextTrimmingProperty TextTrimmingProperty TextTrimmingProperty

Identifies the TextTrimming dependency property.

public : static DependencyProperty TextTrimmingProperty { get; }
public static DependencyProperty TextTrimmingProperty { get; }
Public Static ReadOnly Property TextTrimmingProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.textTrimmingProperty;

TextWrapping TextWrapping TextWrapping TextWrapping

Gets or sets a value that indicates whether text wrapping occurs if a line of text extends beyond the available width of the RichTextBlock.

public : TextWrapping TextWrapping { get; set; }
public TextWrapping TextWrapping { get; set; }
Public ReadWrite Property TextWrapping As TextWrapping
var textWrapping = richTextBlock.textWrapping;
richTextBlock.textWrapping = textWrapping;
<RichTextBlock TextWrapping="Wrap"/>
-or-
<RichTextBlock TextWrapping="NoWrap"/>
Value
TextWrapping TextWrapping TextWrapping TextWrapping

One of the TextWrapping enumeration values that specifies whether text is wrapped. The default is Wrap.

TextWrappingProperty TextWrappingProperty TextWrappingProperty TextWrappingProperty

Identifies the TextWrapping dependency property.

public : static DependencyProperty TextWrappingProperty { get; }
public static DependencyProperty TextWrappingProperty { get; }
Public Static ReadOnly Property TextWrappingProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Controls.RichTextBlock.textWrappingProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the TextWrapping dependency property.

AccessKey AccessKey AccessKey AccessKey

Inherited from UIElement

AccessKeyProperty AccessKeyProperty AccessKeyProperty AccessKeyProperty

Inherited from UIElement

AccessKeyScopeOwner AccessKeyScopeOwner AccessKeyScopeOwner AccessKeyScopeOwner

Inherited from UIElement

AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty

Inherited from UIElement

ActualHeight ActualHeight ActualHeight ActualHeight

Inherited from FrameworkElement

ActualHeightProperty ActualHeightProperty ActualHeightProperty ActualHeightProperty

Inherited from FrameworkElement

ActualTheme ActualTheme ActualTheme ActualTheme

Inherited from FrameworkElement

ActualThemeProperty ActualThemeProperty ActualThemeProperty ActualThemeProperty

Inherited from FrameworkElement

ActualWidth ActualWidth ActualWidth ActualWidth

Inherited from FrameworkElement

ActualWidthProperty ActualWidthProperty ActualWidthProperty ActualWidthProperty

Inherited from FrameworkElement

AllowDrop AllowDrop AllowDrop AllowDrop

Inherited from UIElement

AllowDropProperty AllowDropProperty AllowDropProperty AllowDropProperty

Inherited from UIElement

AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction

Inherited from FrameworkElement

AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty

Inherited from FrameworkElement

AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled AllowFocusWhenDisabled

Inherited from FrameworkElement

AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty AllowFocusWhenDisabledProperty

Inherited from FrameworkElement

BaseUri BaseUri BaseUri BaseUri

Inherited from FrameworkElement

CacheMode CacheMode CacheMode CacheMode

Inherited from UIElement

CacheModeProperty CacheModeProperty CacheModeProperty CacheModeProperty

Inherited from UIElement

CanDrag CanDrag CanDrag CanDrag

Inherited from UIElement

CanDragProperty CanDragProperty CanDragProperty CanDragProperty

Inherited from UIElement

CharacterReceivedEvent CharacterReceivedEvent CharacterReceivedEvent CharacterReceivedEvent

Inherited from UIElement

Clip Clip Clip Clip

Inherited from UIElement

ClipProperty ClipProperty ClipProperty ClipProperty

Inherited from UIElement

CompositeMode CompositeMode CompositeMode CompositeMode

Inherited from UIElement

CompositeModeProperty CompositeModeProperty CompositeModeProperty CompositeModeProperty

Inherited from UIElement

ContextFlyout ContextFlyout ContextFlyout ContextFlyout

Inherited from UIElement

ContextFlyoutProperty ContextFlyoutProperty ContextFlyoutProperty ContextFlyoutProperty

Inherited from UIElement

DataContext DataContext DataContext DataContext

Inherited from FrameworkElement

DataContextProperty DataContextProperty DataContextProperty DataContextProperty

Inherited from FrameworkElement

DesiredSize DesiredSize DesiredSize DesiredSize

Inherited from UIElement

Dispatcher Dispatcher Dispatcher Dispatcher

Inherited from DependencyObject

DoubleTappedEvent DoubleTappedEvent DoubleTappedEvent DoubleTappedEvent

Inherited from UIElement

DragEnterEvent DragEnterEvent DragEnterEvent DragEnterEvent

Inherited from UIElement

DragLeaveEvent DragLeaveEvent DragLeaveEvent DragLeaveEvent

Inherited from UIElement

DragOverEvent DragOverEvent DragOverEvent DragOverEvent

Inherited from UIElement

DropEvent DropEvent DropEvent DropEvent

Inherited from UIElement

ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked

Inherited from UIElement

ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty

Inherited from UIElement

FlowDirection FlowDirection FlowDirection FlowDirection

Inherited from FrameworkElement

FlowDirectionProperty FlowDirectionProperty FlowDirectionProperty FlowDirectionProperty

Inherited from FrameworkElement

FocusVisualMargin FocusVisualMargin FocusVisualMargin FocusVisualMargin

Inherited from FrameworkElement

FocusVisualMarginProperty FocusVisualMarginProperty FocusVisualMarginProperty FocusVisualMarginProperty

Inherited from FrameworkElement

FocusVisualPrimaryBrush FocusVisualPrimaryBrush FocusVisualPrimaryBrush FocusVisualPrimaryBrush

Inherited from FrameworkElement

FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty FocusVisualPrimaryBrushProperty

Inherited from FrameworkElement

FocusVisualPrimaryThickness FocusVisualPrimaryThickness FocusVisualPrimaryThickness FocusVisualPrimaryThickness

Inherited from FrameworkElement

FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty FocusVisualPrimaryThicknessProperty

Inherited from FrameworkElement

FocusVisualSecondaryBrush FocusVisualSecondaryBrush FocusVisualSecondaryBrush FocusVisualSecondaryBrush

Inherited from FrameworkElement

FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty FocusVisualSecondaryBrushProperty

Inherited from FrameworkElement

FocusVisualSecondaryThickness FocusVisualSecondaryThickness FocusVisualSecondaryThickness FocusVisualSecondaryThickness

Inherited from FrameworkElement

FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty FocusVisualSecondaryThicknessProperty

Inherited from FrameworkElement

GettingFocusEvent GettingFocusEvent GettingFocusEvent GettingFocusEvent

Inherited from UIElement

Height Height Height Height

Inherited from FrameworkElement

HeightProperty HeightProperty HeightProperty HeightProperty

Inherited from FrameworkElement

HighContrastAdjustment HighContrastAdjustment HighContrastAdjustment HighContrastAdjustment

Inherited from UIElement

HighContrastAdjustmentProperty HighContrastAdjustmentProperty HighContrastAdjustmentProperty HighContrastAdjustmentProperty

Inherited from UIElement

HoldingEvent HoldingEvent HoldingEvent HoldingEvent

Inherited from UIElement

HorizontalAlignment HorizontalAlignment HorizontalAlignment HorizontalAlignment

Inherited from FrameworkElement

HorizontalAlignmentProperty HorizontalAlignmentProperty HorizontalAlignmentProperty HorizontalAlignmentProperty

Inherited from FrameworkElement

IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope

Inherited from UIElement

IsAccessKeyScopeProperty IsAccessKeyScopeProperty IsAccessKeyScopeProperty IsAccessKeyScopeProperty

Inherited from UIElement

IsDoubleTapEnabled IsDoubleTapEnabled IsDoubleTapEnabled IsDoubleTapEnabled

Inherited from UIElement

IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty IsDoubleTapEnabledProperty

Inherited from UIElement

IsHitTestVisible IsHitTestVisible IsHitTestVisible IsHitTestVisible

Inherited from UIElement

IsHitTestVisibleProperty IsHitTestVisibleProperty IsHitTestVisibleProperty IsHitTestVisibleProperty

Inherited from UIElement

IsHoldingEnabled IsHoldingEnabled IsHoldingEnabled IsHoldingEnabled

Inherited from UIElement

IsHoldingEnabledProperty IsHoldingEnabledProperty IsHoldingEnabledProperty IsHoldingEnabledProperty

Inherited from UIElement

IsRightTapEnabled IsRightTapEnabled IsRightTapEnabled IsRightTapEnabled

Inherited from UIElement

IsRightTapEnabledProperty IsRightTapEnabledProperty IsRightTapEnabledProperty IsRightTapEnabledProperty

Inherited from UIElement

IsTapEnabled IsTapEnabled IsTapEnabled IsTapEnabled

Inherited from UIElement

IsTapEnabledProperty IsTapEnabledProperty IsTapEnabledProperty IsTapEnabledProperty

Inherited from UIElement

KeyboardAccelerators KeyboardAccelerators KeyboardAccelerators KeyboardAccelerators

Inherited from UIElement

KeyDownEvent KeyDownEvent KeyDownEvent KeyDownEvent

Inherited from UIElement

KeyTipHorizontalOffset KeyTipHorizontalOffset KeyTipHorizontalOffset KeyTipHorizontalOffset

Inherited from UIElement

KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty

Inherited from UIElement

KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode

Inherited from UIElement

KeyTipPlacementModeProperty KeyTipPlacementModeProperty KeyTipPlacementModeProperty KeyTipPlacementModeProperty

Inherited from UIElement

KeyTipVerticalOffset KeyTipVerticalOffset KeyTipVerticalOffset KeyTipVerticalOffset

Inherited from UIElement

KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty

Inherited from UIElement

KeyUpEvent KeyUpEvent KeyUpEvent KeyUpEvent

Inherited from UIElement

Language Language Language Language

Inherited from FrameworkElement

LanguageProperty LanguageProperty LanguageProperty LanguageProperty

Inherited from FrameworkElement

Lights Lights Lights Lights

Inherited from UIElement

LightsProperty LightsProperty LightsProperty LightsProperty

Inherited from UIElement

LosingFocusEvent LosingFocusEvent LosingFocusEvent LosingFocusEvent

Inherited from UIElement

ManipulationCompletedEvent ManipulationCompletedEvent ManipulationCompletedEvent ManipulationCompletedEvent

Inherited from UIElement

ManipulationDeltaEvent ManipulationDeltaEvent ManipulationDeltaEvent ManipulationDeltaEvent

Inherited from UIElement

ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent ManipulationInertiaStartingEvent

Inherited from UIElement

ManipulationMode ManipulationMode ManipulationMode ManipulationMode

Inherited from UIElement

ManipulationModeProperty ManipulationModeProperty ManipulationModeProperty ManipulationModeProperty

Inherited from UIElement

ManipulationStartedEvent ManipulationStartedEvent ManipulationStartedEvent ManipulationStartedEvent

Inherited from UIElement

ManipulationStartingEvent ManipulationStartingEvent ManipulationStartingEvent ManipulationStartingEvent

Inherited from UIElement

Margin Margin Margin Margin

Inherited from FrameworkElement

MarginProperty MarginProperty MarginProperty MarginProperty

Inherited from FrameworkElement

MaxHeight MaxHeight MaxHeight MaxHeight

Inherited from FrameworkElement

MaxHeightProperty MaxHeightProperty MaxHeightProperty MaxHeightProperty

Inherited from FrameworkElement

MaxWidth MaxWidth MaxWidth MaxWidth

Inherited from FrameworkElement

MaxWidthProperty MaxWidthProperty MaxWidthProperty MaxWidthProperty

Inherited from FrameworkElement

MinHeight MinHeight MinHeight MinHeight

Inherited from FrameworkElement

MinHeightProperty MinHeightProperty MinHeightProperty MinHeightProperty

Inherited from FrameworkElement

MinWidth MinWidth MinWidth MinWidth

Inherited from FrameworkElement

MinWidthProperty MinWidthProperty MinWidthProperty MinWidthProperty

Inherited from FrameworkElement

Name Name Name Name

Inherited from FrameworkElement

NameProperty NameProperty NameProperty NameProperty

Inherited from FrameworkElement

NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent NoFocusCandidateFoundEvent

Inherited from UIElement

Opacity Opacity Opacity Opacity

Inherited from UIElement

OpacityProperty OpacityProperty OpacityProperty OpacityProperty

Inherited from UIElement

Parent Parent Parent Parent

Inherited from FrameworkElement

PointerCanceledEvent PointerCanceledEvent PointerCanceledEvent PointerCanceledEvent

Inherited from UIElement

PointerCaptureLostEvent PointerCaptureLostEvent PointerCaptureLostEvent PointerCaptureLostEvent

Inherited from UIElement

PointerCaptures PointerCaptures PointerCaptures PointerCaptures

Inherited from UIElement

PointerCapturesProperty PointerCapturesProperty PointerCapturesProperty PointerCapturesProperty

Inherited from UIElement

PointerEnteredEvent PointerEnteredEvent PointerEnteredEvent PointerEnteredEvent

Inherited from UIElement

PointerExitedEvent PointerExitedEvent PointerExitedEvent PointerExitedEvent

Inherited from UIElement

PointerMovedEvent PointerMovedEvent PointerMovedEvent PointerMovedEvent

Inherited from UIElement

PointerPressedEvent PointerPressedEvent PointerPressedEvent PointerPressedEvent

Inherited from UIElement

PointerReleasedEvent PointerReleasedEvent PointerReleasedEvent PointerReleasedEvent

Inherited from UIElement

PointerWheelChangedEvent PointerWheelChangedEvent PointerWheelChangedEvent PointerWheelChangedEvent

Inherited from UIElement

PreviewKeyDownEvent PreviewKeyDownEvent PreviewKeyDownEvent PreviewKeyDownEvent

Inherited from UIElement

PreviewKeyUpEvent PreviewKeyUpEvent PreviewKeyUpEvent PreviewKeyUpEvent

Inherited from UIElement

Projection Projection Projection Projection

Inherited from UIElement

ProjectionProperty ProjectionProperty ProjectionProperty ProjectionProperty

Inherited from UIElement

RenderSize RenderSize RenderSize RenderSize

Inherited from UIElement

RenderTransform RenderTransform RenderTransform RenderTransform

Inherited from UIElement

RenderTransformOrigin RenderTransformOrigin RenderTransformOrigin RenderTransformOrigin

Inherited from UIElement

RenderTransformOriginProperty RenderTransformOriginProperty RenderTransformOriginProperty RenderTransformOriginProperty

Inherited from UIElement

RenderTransformProperty RenderTransformProperty RenderTransformProperty RenderTransformProperty

Inherited from UIElement

RequestedTheme RequestedTheme RequestedTheme RequestedTheme

Inherited from FrameworkElement

RequestedThemeProperty RequestedThemeProperty RequestedThemeProperty RequestedThemeProperty

Inherited from FrameworkElement

Resources Resources Resources Resources

Inherited from FrameworkElement

RightTappedEvent RightTappedEvent RightTappedEvent RightTappedEvent

Inherited from UIElement

Style Style Style Style

Inherited from FrameworkElement

StyleProperty StyleProperty StyleProperty StyleProperty

Inherited from FrameworkElement

TabFocusNavigation TabFocusNavigation TabFocusNavigation TabFocusNavigation

Inherited from UIElement

TabFocusNavigationProperty TabFocusNavigationProperty TabFocusNavigationProperty TabFocusNavigationProperty

Inherited from UIElement

Tag Tag Tag Tag

Inherited from FrameworkElement

TagProperty TagProperty TagProperty TagProperty

Inherited from FrameworkElement

TappedEvent TappedEvent TappedEvent TappedEvent

Inherited from UIElement

Transform3D Transform3D Transform3D Transform3D

Inherited from UIElement

Transform3DProperty Transform3DProperty Transform3DProperty Transform3DProperty

Inherited from UIElement

Transitions Transitions Transitions Transitions

Inherited from UIElement

TransitionsProperty TransitionsProperty TransitionsProperty TransitionsProperty

Inherited from UIElement

Triggers Triggers Triggers Triggers

Inherited from FrameworkElement

UseLayoutRounding UseLayoutRounding UseLayoutRounding UseLayoutRounding

Inherited from UIElement

UseLayoutRoundingProperty UseLayoutRoundingProperty UseLayoutRoundingProperty UseLayoutRoundingProperty

Inherited from UIElement

VerticalAlignment VerticalAlignment VerticalAlignment VerticalAlignment

Inherited from FrameworkElement

VerticalAlignmentProperty VerticalAlignmentProperty VerticalAlignmentProperty VerticalAlignmentProperty

Inherited from FrameworkElement

Visibility Visibility Visibility Visibility

Inherited from UIElement

VisibilityProperty VisibilityProperty VisibilityProperty VisibilityProperty

Inherited from UIElement

Width Width Width Width

Inherited from FrameworkElement

WidthProperty WidthProperty WidthProperty WidthProperty

Inherited from FrameworkElement

XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy XYFocusDownNavigationStrategy

Inherited from UIElement

XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty XYFocusDownNavigationStrategyProperty

Inherited from UIElement

XYFocusKeyboardNavigation XYFocusKeyboardNavigation XYFocusKeyboardNavigation XYFocusKeyboardNavigation

Inherited from UIElement

XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty XYFocusKeyboardNavigationProperty

Inherited from UIElement

XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy XYFocusLeftNavigationStrategy

Inherited from UIElement

XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty XYFocusLeftNavigationStrategyProperty

Inherited from UIElement

XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy XYFocusRightNavigationStrategy

Inherited from UIElement

XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty XYFocusRightNavigationStrategyProperty

Inherited from UIElement

XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy XYFocusUpNavigationStrategy

Inherited from UIElement

XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty XYFocusUpNavigationStrategyProperty

Inherited from UIElement

Methods

Focus(FocusState) Focus(FocusState) Focus(FocusState) Focus(FocusState)

Focuses the RichTextBlock, as if it were a conventionally focusable control.

public : Platform::Boolean Focus(FocusState value)
public bool Focus(FocusState value)
Public Function Focus(value As FocusState) As bool
var bool = richTextBlock.focus(value);
Parameters
value
FocusState FocusState FocusState FocusState

Specifies the desired target for focus state, as a value of the enumeration.

Returns
Platform::Boolean bool bool bool

true if focus was set to the RichTextBlock, or focus was already there. false if the RichTextBlock is not focusable.

Remarks

GetPositionFromPoint(Point) GetPositionFromPoint(Point) GetPositionFromPoint(Point) GetPositionFromPoint(Point)

Returns a TextPointer text reference from a RichTextBlock by hit-testing a specific Point within the text display area.

public : TextPointer GetPositionFromPoint(Point point)
public TextPointer GetPositionFromPoint(Point point)
Public Function GetPositionFromPoint(point As Point) As TextPointer
var textPointer = richTextBlock.getPositionFromPoint(point);
Parameters
point
Point Point Point Point

The point to test.

Returns

The determined text reference.

Select(TextPointer, TextPointer) Select(TextPointer, TextPointer) Select(TextPointer, TextPointer) Select(TextPointer, TextPointer)

Selects a range of text in the RichTextBlock.

public : void Select(TextPointer start, TextPointer end)
public void Select(TextPointer start, TextPointer end)
Public Function Select(start As TextPointer, end As TextPointer) As void
richTextBlock.select(start, end);
Parameters
start
TextPointer TextPointer TextPointer TextPointer

An object that represents the start of the range to select.

end
TextPointer TextPointer TextPointer TextPointer

An object that represents the end of the range to select.

Remarks

In Windows Presentation Foundation (WPF) and Microsoft Silverlight the equivalent API uses integer for start and end positions. This implementation uses TextPointer objects to specify the selection.

SelectAll() SelectAll() SelectAll() SelectAll()

Selects the entire contents in the RichTextBlock.

public : void SelectAll()
public void SelectAll()
Public Function SelectAll() As void
richTextBlock.selectAll();

AddHandler(RoutedEvent,Object,Boolean) AddHandler(RoutedEvent,Object,Boolean) AddHandler(RoutedEvent,Object,Boolean) AddHandler(RoutedEvent,Object,Boolean)

Inherited from UIElement

Arrange(Rect) Arrange(Rect) Arrange(Rect) Arrange(Rect)

Inherited from UIElement

ArrangeOverride(Size) ArrangeOverride(Size) ArrangeOverride(Size) ArrangeOverride(Size)

Inherited from FrameworkElement

CancelDirectManipulations CancelDirectManipulations CancelDirectManipulations CancelDirectManipulations

Inherited from UIElement

CapturePointer(Pointer) CapturePointer(Pointer) CapturePointer(Pointer) CapturePointer(Pointer)

Inherited from UIElement

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Inherited from DependencyObject

DeferTree(DependencyObject) DeferTree(DependencyObject) DeferTree(DependencyObject) DeferTree(DependencyObject)

Inherited from FrameworkElement

FindName(String) FindName(String) FindName(String) FindName(String)

Inherited from FrameworkElement

FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect) FindSubElementsForTouchTargeting(Point,Rect)

Inherited from UIElement

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Inherited from DependencyObject

GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty) GetBindingExpression(DependencyProperty)

Inherited from FrameworkElement

GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder GetChildrenInTabFocusOrder

Inherited from UIElement

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Inherited from DependencyObject

GoToElementStateCore(String,Boolean) GoToElementStateCore(String,Boolean) GoToElementStateCore(String,Boolean) GoToElementStateCore(String,Boolean)

Inherited from FrameworkElement

InvalidateArrange InvalidateArrange InvalidateArrange InvalidateArrange

Inherited from UIElement

InvalidateMeasure InvalidateMeasure InvalidateMeasure InvalidateMeasure

Inherited from UIElement

Measure(Size) Measure(Size) Measure(Size) Measure(Size)

Inherited from UIElement

MeasureOverride(Size) MeasureOverride(Size) MeasureOverride(Size) MeasureOverride(Size)

Inherited from FrameworkElement

OnApplyTemplate OnApplyTemplate OnApplyTemplate OnApplyTemplate

Inherited from FrameworkElement

OnCreateAutomationPeer OnCreateAutomationPeer OnCreateAutomationPeer OnCreateAutomationPeer

Inherited from UIElement

OnDisconnectVisualChildren OnDisconnectVisualChildren OnDisconnectVisualChildren OnDisconnectVisualChildren

Inherited from UIElement

OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs) OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)

Inherited from UIElement

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Inherited from DependencyObject

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Inherited from DependencyObject

ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer) ReleasePointerCapture(Pointer)

Inherited from UIElement

ReleasePointerCaptures ReleasePointerCaptures ReleasePointerCaptures ReleasePointerCaptures

Inherited from UIElement

RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object) RemoveHandler(RoutedEvent,Object)

Inherited from UIElement

SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase) SetBinding(DependencyProperty,BindingBase)

Inherited from FrameworkElement

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Inherited from DependencyObject

StartBringIntoView StartBringIntoView StartBringIntoView StartBringIntoView

Inherited from UIElement

StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions) StartBringIntoView(BringIntoViewOptions)

Inherited from UIElement

StartDragAsync(PointerPoint) StartDragAsync(PointerPoint) StartDragAsync(PointerPoint) StartDragAsync(PointerPoint)

Inherited from UIElement

TransformToVisual(UIElement) TransformToVisual(UIElement) TransformToVisual(UIElement) TransformToVisual(UIElement)

Inherited from UIElement

TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs) TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)

Inherited from UIElement

TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer) TryStartDirectManipulation(Pointer)

Inherited from UIElement

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Inherited from DependencyObject

UpdateLayout UpdateLayout UpdateLayout UpdateLayout

Inherited from UIElement

Events

ContextMenuOpening ContextMenuOpening ContextMenuOpening ContextMenuOpening

Occurs when the system processes an interaction that displays a context menu.

public : event ContextMenuOpeningEventHandler ContextMenuOpening<>
public event ContextMenuOpeningEventHandler ContextMenuOpening<>
Public Event ContextMenuOpeningEventHandler ContextMenuOpening( Of )
function onContextMenuOpening(eventArgs){/* Your code */}


richTextBlock.addEventListener("contextMenuOpening", onContextMenuOpening);
richTextBlock.removeEventListener("contextMenuOpening", onContextMenuOpening);
<RichTextBlock ContextMenuOpening="eventhandler" />

IsTextTrimmedChanged IsTextTrimmedChanged IsTextTrimmedChanged IsTextTrimmedChanged

Occurs when the IsTextTrimmed property value has changed.

public : event TypedEventHandler IsTextTrimmedChanged<RichTextBlock,  IsTextTrimmedChangedEventArgs>
public event TypedEventHandler IsTextTrimmedChanged<RichTextBlock,  IsTextTrimmedChangedEventArgs>
Public Event TypedEventHandler IsTextTrimmedChanged( Of ( Of RichTextBlock ), ( Of  IsTextTrimmedChangedEventArgs ))
function onIsTextTrimmedChanged(eventArgs){/* Your code */}


richTextBlock.addEventListener("isTextTrimmedChanged", onIsTextTrimmedChanged);
richTextBlock.removeEventListener("isTextTrimmedChanged", onIsTextTrimmedChanged);
<RichTextBlock IsTextTrimmedChanged="eventhandler"/>

Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

SelectionChanged SelectionChanged SelectionChanged SelectionChanged

Occurs when the text selection has changed.

public : event RoutedEventHandler SelectionChanged<>
public event RoutedEventHandler SelectionChanged<>
Public Event RoutedEventHandler SelectionChanged( Of )
function onSelectionChanged(eventArgs){/* Your code */}


richTextBlock.addEventListener("selectionChanged", onSelectionChanged);
richTextBlock.removeEventListener("selectionChanged", onSelectionChanged);
<RichTextBlock SelectionChanged="eventhandler"/>

AccessKeyDisplayDismissed AccessKeyDisplayDismissed AccessKeyDisplayDismissed AccessKeyDisplayDismissed

Inherited from UIElement

AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested

Inherited from UIElement

AccessKeyInvoked AccessKeyInvoked AccessKeyInvoked AccessKeyInvoked

Inherited from UIElement

ActualThemeChanged ActualThemeChanged ActualThemeChanged ActualThemeChanged

Inherited from FrameworkElement

CharacterReceived CharacterReceived CharacterReceived CharacterReceived

Inherited from UIElement

ContextCanceled ContextCanceled ContextCanceled ContextCanceled

Inherited from UIElement

ContextRequested ContextRequested ContextRequested ContextRequested

Inherited from UIElement

DataContextChanged DataContextChanged DataContextChanged DataContextChanged

Inherited from FrameworkElement

DoubleTapped DoubleTapped DoubleTapped DoubleTapped

Inherited from UIElement

DragEnter DragEnter DragEnter DragEnter

Inherited from UIElement

DragLeave DragLeave DragLeave DragLeave

Inherited from UIElement

DragOver DragOver DragOver DragOver

Inherited from UIElement

DragStarting DragStarting DragStarting DragStarting

Inherited from UIElement

Drop Drop Drop Drop

Inherited from UIElement

DropCompleted DropCompleted DropCompleted DropCompleted

Inherited from UIElement

GettingFocus GettingFocus GettingFocus GettingFocus

Inherited from UIElement

GotFocus GotFocus GotFocus GotFocus

Inherited from UIElement

Holding Holding Holding Holding

Inherited from UIElement

KeyDown KeyDown KeyDown KeyDown

Inherited from UIElement

KeyUp KeyUp KeyUp KeyUp

Inherited from UIElement

LayoutUpdated LayoutUpdated LayoutUpdated LayoutUpdated

Inherited from FrameworkElement

Loaded Loaded Loaded Loaded

Inherited from FrameworkElement

Loading Loading Loading Loading

Inherited from FrameworkElement

LosingFocus LosingFocus LosingFocus LosingFocus

Inherited from UIElement

LostFocus LostFocus LostFocus LostFocus

Inherited from UIElement

ManipulationCompleted ManipulationCompleted ManipulationCompleted ManipulationCompleted

Inherited from UIElement

ManipulationDelta ManipulationDelta ManipulationDelta ManipulationDelta

Inherited from UIElement

ManipulationInertiaStarting ManipulationInertiaStarting ManipulationInertiaStarting ManipulationInertiaStarting

Inherited from UIElement

ManipulationStarted ManipulationStarted ManipulationStarted ManipulationStarted

Inherited from UIElement

ManipulationStarting ManipulationStarting ManipulationStarting ManipulationStarting

Inherited from UIElement

NoFocusCandidateFound NoFocusCandidateFound NoFocusCandidateFound NoFocusCandidateFound

Inherited from UIElement

PointerCanceled PointerCanceled PointerCanceled PointerCanceled

Inherited from UIElement

PointerCaptureLost PointerCaptureLost PointerCaptureLost PointerCaptureLost

Inherited from UIElement

PointerEntered PointerEntered PointerEntered PointerEntered

Inherited from UIElement

PointerExited PointerExited PointerExited PointerExited

Inherited from UIElement

PointerMoved PointerMoved PointerMoved PointerMoved

Inherited from UIElement

PointerPressed PointerPressed PointerPressed PointerPressed

Inherited from UIElement

PointerReleased PointerReleased PointerReleased PointerReleased

Inherited from UIElement

PointerWheelChanged PointerWheelChanged PointerWheelChanged PointerWheelChanged

Inherited from UIElement

PreviewKeyDown PreviewKeyDown PreviewKeyDown PreviewKeyDown

Inherited from UIElement

PreviewKeyUp PreviewKeyUp PreviewKeyUp PreviewKeyUp

Inherited from UIElement

ProcessKeyboardAccelerators ProcessKeyboardAccelerators ProcessKeyboardAccelerators ProcessKeyboardAccelerators

Inherited from UIElement

RightTapped RightTapped RightTapped RightTapped

Inherited from UIElement

SizeChanged SizeChanged SizeChanged SizeChanged

Inherited from FrameworkElement

Tapped Tapped Tapped Tapped

Inherited from UIElement

Unloaded Unloaded Unloaded Unloaded

Inherited from FrameworkElement

See Also