Développer Réduire

RichTextBlock Class

Représente un conteneur d'affichage de texte enrichi qui prend en charge le texte mis en forme, les liens hypertexte, les images incluses et tout autre contenu riche. RichTextBlock prend en charge un modèle prédéfini de dépassement de capacité.

Héritage

Object
  DependencyObject
    UIElement
      FrameworkElement
        RichTextBlock

Syntaxe

Public NotInheritable Class RichTextBlock  
    Inherits FrameworkElement

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

XAML Values

blocksContent

Un ou plusieurs éléments objet pour les types dérivés de Block. En général, ce sont les éléments Paragraph.

Attributs

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

Membres

RichTextBlockClasse comporte les types de membres suivants :

Constructeurs

RichTextBlockClasse comporte les constructeurs suivants.

ConstructeurDescription
RichTextBlock Initializes a new instance of the RichTextBlock class.

 

Événements

RichTextBlockClasse comporte les événements suivants.

ÉvénementDescription
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. (Hérité de UIElement)
DragEnter Occurs when the input system reports an underlying drag event with this element as the target. (Hérité de UIElement)
DragLeave Occurs when the input system reports an underlying drag event with this element as the origin. (Hérité de UIElement)
DragOver Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Hérité de UIElement)
Drop Occurs when the input system reports an underlying drop event with this element as the drop target. (Hérité de UIElement)
GotFocus Occurs when a UIElement receives focus. (Hérité de UIElement)
Holding Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (Hérité de UIElement)
KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Hérité de UIElement)
KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Hérité de UIElement)
LayoutUpdated Occurs when the layout of the visual tree changes. (Hérité de FrameworkElement)
Loaded Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. (Hérité de FrameworkElement)
LostFocus Occurs when a UIElement loses focus. (Hérité de UIElement)
ManipulationCompleted Occurs when a manipulation on the UIElement is complete. (Hérité de UIElement)
ManipulationDelta Occurs when the input device changes position during a manipulation. (Hérité de UIElement)
ManipulationInertiaStarting Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Hérité de UIElement)
ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Hérité de UIElement)
ManipulationStarting Occurs when the manipulation processor is first created. (Hérité de UIElement)
PointerCanceled Occurs when a pointer that made contact abnormally loses contact. (Hérité de UIElement)
PointerCaptureLost Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Hérité de UIElement)
PointerEntered Occurs when a pointer enters the hit test area of this element. (Hérité de UIElement)
PointerExited Occurs when a pointer leaves the hit test area of this element. (Hérité de UIElement)
PointerMoved Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Hérité de UIElement)
PointerPressed Occurs when the pointer device initiates a Press action within this element. (Hérité de UIElement)
PointerReleased Occurs when the pointer device that previously initiated a Press action is released, while within this element. (Hérité de UIElement)
PointerWheelChanged Occurs when the delta value of a pointer wheel changes. (Hérité de UIElement)
RightTapped Occurs when a right-tap input stimulus happens while the pointer is over the element. (Hérité de UIElement)
SelectionChanged Occurs when the text selection has changed.
SizeChanged Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Hérité de FrameworkElement)
Tapped Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Hérité de UIElement)
Unloaded Occurs when this object is no longer connected to the main object tree. (Hérité de FrameworkElement)

 

Méthodes

The RichTextBlock Classe comporte les méthodes suivantes. Il hérite également des méthodes de Object Classe.

MéthodeDescription
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. (Hérité de 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. (Hérité de UIElement)
ArrangeOverride Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. (Hérité de FrameworkElement)
CapturePointer Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Hérité de UIElement)
ClearValue Clears the local value of a dependency property. (Hérité de DependencyObject)
FindName Retrieves an object that has the specified identifier name. (Hérité de FrameworkElement)
FindSubElementsForTouchTargeting Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Hérité de 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. (Hérité de 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. (Hérité de DependencyObject)
InvalidateArrange Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Hérité de UIElement)
InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Hérité de 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. (Hérité de 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. (Hérité de 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. (Hérité de FrameworkElement)
OnCreateAutomationPeer When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure. (Hérité de 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. (Hérité de UIElement)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Hérité de DependencyObject)
ReleasePointerCapture Releases pointer captures for capture of one specific pointer by this UIElement. (Hérité de UIElement)
ReleasePointerCaptures Releases all pointer captures held by this element. (Hérité de UIElement)
RemoveHandler Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Hérité de 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. (Hérité de FrameworkElement)
SetValue Sets the local value of a dependency property on a DependencyObject. (Hérité de DependencyObject)
TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Hérité de UIElement)
UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Hérité de UIElement)

 

Propriétés

Le RichTextBlockClasse contient les propriétés suivantes.

PropriétéType d’accèsDescription

ActualHeight

en lecture seuleGets the rendered height of a FrameworkElement. (Hérité de FrameworkElement)

ActualWidth

en lecture seuleGets the rendered width of a FrameworkElement. (Hérité de FrameworkElement)

AllowDrop

en lecture/écritureGets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Hérité de UIElement)

BaselineOffset

en lecture seuleGets 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

en lecture seuleGets 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. (Hérité de FrameworkElement)

Blocks

en lecture seuleGets the contents of the RichTextBlock.

CacheMode

en lecture/écritureGets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Hérité de UIElement)

CharacterSpacing

en lecture/écritureGets or sets the uniform spacing between characters, in units of 1/1000 of an em.

CharacterSpacingProperty

en lecture seuleIdentifies the CharacterSpacing dependency property.

Clip

en lecture/écritureGets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Hérité de UIElement)

ContentEnd

en lecture seuleGets a TextPointer that indicates the end of content in the RichTextBlock.

ContentStart

en lecture seuleGets a TextPointer that indicates the start of content in the RichTextBlock.

DataContext

en lecture/écritureGets or sets the data context for a FrameworkElement when it participates in data binding. (Hérité de FrameworkElement)

DesiredSize

en lecture seuleGets the size that this UIElement computed during the measure pass of the layout process. (Hérité de UIElement)

Dispatcher

en lecture seuleGets the CoreDispatcher that this object is associated with. (Hérité de DependencyObject)

FlowDirection

en lecture/écritureGets 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. (Hérité de FrameworkElement)

FontFamily

en lecture/écritureGets or sets the preferred top-level font family for the text content in this element.

FontFamilyProperty

en lecture seuleIdentifies the FontFamily dependency property.

FontSize

en lecture/écritureGets or sets the font size for the text content in this element.

FontSizeProperty

en lecture seuleIdentifies the FontSize dependency property.

FontStretch

en lecture/écritureGets or sets the font stretch for the text content in this element.

FontStretchProperty

en lecture seuleIdentifies the FontStretch dependency property.

FontStyle

en lecture/écritureGets or sets the font style for the content in this element.

FontStyleProperty

en lecture seuleIdentifies the FontStyle dependency property.

FontWeight

en lecture/écritureGets or sets the top-level font weight for the RichTextBlock.

FontWeightProperty

en lecture seuleIdentifies the FontWeight dependency property.

Foreground

en lecture/écritureGets or sets the Brush to apply to the text contents of the RichTextBlock.

ForegroundProperty

en lecture seuleIdentifies the Foreground dependency property.

HasOverflowContent

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

HasOverflowContentProperty

en lecture seuleIdentifies the HasOverflowContent dependency property.

Height

en lecture/écritureGets or sets the suggested height of a FrameworkElement. (Hérité de FrameworkElement)

HorizontalAlignment

en lecture/écritureGets 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. (Hérité de FrameworkElement)

IsDoubleTapEnabled

en lecture/écritureGets or sets a value that determines whether the DoubleTapped event can originate from that element. (Hérité de UIElement)

IsHitTestVisible

en lecture/écritureGets or sets whether the contained area of this UIElement can return true values for hit testing. (Hérité de UIElement)

IsHoldingEnabled

en lecture/écritureGets or sets a value that determines whether the Holding event can originate from that element. (Hérité de UIElement)

IsRightTapEnabled

en lecture/écritureGets or sets a value that determines whether the RightTapped event can originate from that element. (Hérité de UIElement)

IsTapEnabled

en lecture/écritureGets or sets a value that determines whether the Tapped event can originate from that element. (Hérité de UIElement)

IsTextSelectionEnabled

en lecture/écritureGets 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

en lecture seuleIdentifies the IsTextSelectionEnabled dependency property.

Language

en lecture/écritureGets 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. (Hérité de FrameworkElement)

LineHeight

en lecture/écritureGets or sets the height of each line of content.

LineHeightProperty

en lecture seuleIdentifies the LineHeight dependency property.

LineStackingStrategy

en lecture/écritureGets or sets a value that indicates how a line box is determined for each line of text in the RichTextBlock.

LineStackingStrategyProperty

en lecture seuleIdentifies the LineStackingStrategy dependency property.

ManipulationMode

en lecture/écritureGets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. (Hérité de UIElement)

Margin

en lecture/écritureGets or sets the outer margin of a FrameworkElement. (Hérité de FrameworkElement)

MaxHeight

en lecture/écritureGets or sets the maximum height constraint of a FrameworkElement. (Hérité de FrameworkElement)

MaxWidth

en lecture/écritureGets or sets the maximum width constraint of a FrameworkElement. (Hérité de FrameworkElement)

MinHeight

en lecture/écritureGets or sets the minimum height constraint of a FrameworkElement. (Hérité de FrameworkElement)

MinWidth

en lecture/écritureGets or sets the minimum width constraint of a FrameworkElement. (Hérité de FrameworkElement)

Name

en lecture/écritureGets 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. (Hérité de FrameworkElement)

Opacity

en lecture/écritureGets or sets the degree of the object's opacity. (Hérité de UIElement)

OverflowContentTarget

en lecture/écritureGets or sets a reference to a RichTextBlockOverflow that is the linked target for any text overflow from this RichTextBlock.

OverflowContentTargetProperty

en lecture seuleIdentifies the OverflowContentTarget dependency property.

Padding

en lecture/écritureGets 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

en lecture seuleIdentifies the Padding dependency property.

Parent

en lecture seuleGets the parent object of this FrameworkElement in the object tree. (Hérité de FrameworkElement)

PointerCaptures

en lecture seuleGets the set of all captured pointers, represented as Pointer values. (Hérité de UIElement)

Projection

en lecture/écritureGets or sets the perspective projection (3-D effect) to apply when rendering this element. (Hérité de UIElement)

RenderSize

en lecture seuleGets the final render size of a UIElement. (Hérité de UIElement)

RenderTransform

en lecture/écritureGets or sets transform information that affects the rendering position of a UIElement. (Hérité de UIElement)

RenderTransformOrigin

en lecture/écritureGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Hérité de UIElement)

Resources

en lecture/écritureGets 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. (Hérité de FrameworkElement)

SelectedText

en lecture seuleGets a text range of selected text.

SelectedTextProperty

en lecture seuleIdentifies the SelectedText dependency property.

SelectionEnd

en lecture seuleGets the end position of the text selected in the RichTextBlock.

SelectionStart

en lecture seuleGets the starting position of the text selected in the RichTextBlock .

Style

en lecture/écritureGets or sets an instance Style that is applied for this object during layout and rendering. (Hérité de FrameworkElement)

Tag

en lecture/écritureGets or sets an arbitrary object value that can be used to store custom information about this object. (Hérité de FrameworkElement)

TextAlignment

en lecture/écritureGets or sets a value that indicates how the text is aligned in the RichTextBlock.

TextAlignmentProperty

en lecture seuleIdentifies the TextAlignment dependency property.

TextIndent

en lecture/écritureGets or sets the indentation of the first line of text in each paragraph in the RichTextBlock.

TextIndentProperty

en lecture seuleIdentifies the TextIndent dependency property.

TextTrimming

en lecture/écritureGets or sets a value that indicates how text is trimmed when it overflows the content area.

TextTrimmingProperty

en lecture seuleIdentifies the TextTrimming dependency property.

TextWrapping

en lecture/écritureGets or sets a value that indicates whether text wrapping occurs if a line of text extends beyond the available width of the RichTextBlock.

TextWrappingProperty

en lecture seuleIdentifies the TextWrapping dependency property.

Transitions

en lecture/écritureGets or sets the collection of Transition style elements that apply to a UIElement. (Hérité de UIElement)

Triggers

en lecture seuleGets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Hérité de FrameworkElement)

UseLayoutRounding

en lecture/écritureGets 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. (Hérité de UIElement)

VerticalAlignment

en lecture/écritureGets 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. (Hérité de FrameworkElement)

Visibility

en lecture/écritureGets 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. (Hérité de UIElement)

Width

en lecture/écritureGets or sets the width of a FrameworkElement. (Hérité de FrameworkElement)

 

Remarques

RichTextBlock fournit des fonctionnalités de mise en forme plus avancées que le contrôle TextBlock. Vous pouvez appliquer la mise en forme de caractère et de paragraphe au texte dans RichTextBlock. Par exemple, vous pouvez appliquer Bold, Italic et Underline à toute partie du texte dans le contrôle. La propriété de contenu de RichTextBlock est la propriété Blocks, basée sur l'élément Paragraph. Vous pouvez utiliser la RichTextBlock pour afficher du texte avec des éléments d'interface utilisateur dérivés de UIElement, tels que des images. Pour cela, vous pouvez utiliser le InlineUIContainer.

Vous pouvez utiliser un RichTextBlock avec des éléments RichTextBlockOverflow pour créer des mises en page avancées. Le contenu d'un élément RichTextBlockOverflow provient toujours d'un élément RichTextBlock. Vous liez les éléments RichTextBlockOverflow en les définissant comme OverflowContentTarget d'un RichTextBlock ou d'un autre RichTextBlockOverflow.

Exemples

Dans cet exemple, un objet RichTextBlock cible un élément RichTextBlockOverflow pour créer une disposition du texte à plusieurs colonnes. Le premier élément RichTextBlockOverflow cible ensuite un deuxième élément RichTextBlockOverflow qui reçoit le dépassement de contenu. Le facteur de contrôle de disposition concernant le mode selon lequel le dépassement de texte est calculé est le Width et le Height limités du Grid parent, et les paramètres ColumnDefinition qui divisent le Grid en trois colonnes égales de 300 pixels de hauteur/largeur. Le dépassement est également affecté par FontSize et de nombreuses autres propriétés de mise en forme de texte qui modifient les caractères du texte.


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


Pour obtenir plus d'exemples, consultez le scénario 4 "Linked text containers", de l'exemple XAML text display.

Configuration requise

Client minimal pris en charge

Windows 8 [Applications du Windows Store uniquement]

Serveur minimal pris en charge

Windows Server 2012 [Applications du Windows Store uniquement]

Espace de noms

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Métadonnées

Windows.winmd

Voir aussi

FrameworkElement
Paragraph
OverflowContentTarget
RichTextBlockOverflow
RichTextBlockOverflow.OverflowContentTarget
Exemple d'affichage de texte en XAML

 

 

Afficher:
© 2014 Microsoft