FormattedText FormattedText FormattedText FormattedText Class

Définition

Fournit un contrôle de bas niveau pour dessiner du texte dans les applications WPF (Windows Presentation Foundation).Provides low-level control for drawing text in Windows Presentation Foundation (WPF) applications.

public ref class FormattedText
public class FormattedText
type FormattedText = class
Public Class FormattedText
Héritage
FormattedTextFormattedTextFormattedTextFormattedText

Exemples

L’exemple suivant crée un FormattedText objet, puis applique plusieurs styles de mise en forme au texte.The following example creates a FormattedText object and then applies several formatting styles to the text.

protected override void OnRender(DrawingContext drawingContext)
{
    string testString = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor";

    // Create the initial formatted text string.
    FormattedText formattedText = new FormattedText(
        testString,
        CultureInfo.GetCultureInfo("en-us"),
        FlowDirection.LeftToRight,
        new Typeface("Verdana"),
        32,
        Brushes.Black);

    // Set a maximum width and height. If the text overflows these values, an ellipsis "..." appears.
    formattedText.MaxTextWidth = 300;
    formattedText.MaxTextHeight = 240;

    // Use a larger font size beginning at the first (zero-based) character and continuing for 5 characters.
    // The font size is calculated in terms of points -- not as device-independent pixels.
    formattedText.SetFontSize(36 * (96.0 / 72.0), 0, 5);

    // Use a Bold font weight beginning at the 6th character and continuing for 11 characters.
    formattedText.SetFontWeight(FontWeights.Bold, 6, 11);

    // Use a linear gradient brush beginning at the 6th character and continuing for 11 characters.
    formattedText.SetForegroundBrush(
                            new LinearGradientBrush(
                            Colors.Orange,
                            Colors.Teal,
                            90.0),
                            6, 11);

    // Use an Italic font style beginning at the 28th character and continuing for 28 characters.
    formattedText.SetFontStyle(FontStyles.Italic, 28, 28);

    // Draw the formatted text string to the DrawingContext of the control.
    drawingContext.DrawText(formattedText, new Point(10, 0));
}
Protected Overrides Sub OnRender(ByVal drawingContext As DrawingContext)
    Dim testString As String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor"

    ' Create the initial formatted text string.
    Dim formattedText As New FormattedText(testString, CultureInfo.GetCultureInfo("en-us"), FlowDirection.LeftToRight, New Typeface("Verdana"), 32, Brushes.Black)

    ' Set a maximum width and height. If the text overflows these values, an ellipsis "..." appears.
    formattedText.MaxTextWidth = 300
    formattedText.MaxTextHeight = 240

    ' Use a larger font size beginning at the first (zero-based) character and continuing for 5 characters.
    ' The font size is calculated in terms of points -- not as device-independent pixels.
    formattedText.SetFontSize(36 * (96.0 / 72.0), 0, 5)

    ' Use a Bold font weight beginning at the 6th character and continuing for 11 characters.
    formattedText.SetFontWeight(FontWeights.Bold, 6, 11)

    ' Use a linear gradient brush beginning at the 6th character and continuing for 11 characters.
    formattedText.SetForegroundBrush(New LinearGradientBrush(Colors.Orange, Colors.Teal, 90.0), 6, 11)

    ' Use an Italic font style beginning at the 28th character and continuing for 28 characters.
    formattedText.SetFontStyle(FontStyles.Italic, 28, 28)

    ' Draw the formatted text string to the DrawingContext of the control.
    drawingContext.DrawText(formattedText, New Point(10, 0))
End Sub

Remarques

L' FormattedText objet vous permet de dessiner du texte multiligne, dans lequel chaque caractère du texte peut être mis en forme individuellement.The FormattedText object allows you to draw multi-line text, in which each character in the text can be individually formatted. L’exemple suivant montre un texte auquel plusieurs formats sont appliqués.The following example shows text that has several formats applied to it.

![Texte affiché à l’aide de l’objet FormattedText] (~/add/media/formattedtext01.jpg "Texte affiché à l’aide de l’objet FormattedText")Text displayed using FormattedText object
Exemple de chaîne de texte mise en formeExample of a formatted text string

En termes de fonctionnalités de texte WPFWPFdans FormattedText , est considéré comme «de bas niveau», car il traite le texte comme des éléments graphiques.In terms of text features in WPFWPF, FormattedText is considered "low-level" because it processes text as graphical elements. D’autres aspects du texte WPFWPF dans gèrent le texte dans le contexte des contrôles dédiés au texteTextBlock( TextBox,), implémentent le modèle de document dynamique (consultez vue d’ensemble des documents dynamiques) ou prennent en charge le XPSXPS modèle de document ( consultez documents dans WPF).Other aspects of text in WPFWPF handle text in the context of controls that are dedicated to text (TextBlock, TextBox), implement the flow document model (see Flow Document Overview), or support the XPSXPS document model (see Documents in WPF).

La plupart des méthodes FormattedText Setter de ont des similitudes avec les propriétés jointes prises en charge par TextElement TextElement, mais les propriétés jointes s’appliquent à la prise en charge XPSXPSdu texte de niveau supérieur pour Flow ou.Many of the setter methods in FormattedText have similarities to attached properties that are supported by TextElement, but the TextElement attached properties apply to the higher-level text support either for flow or XPSXPS.

Constructeurs

FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush)

Initialise une nouvelle instance de la classe FormattedText avec le texte, la culture, le sens du flux, la police, la taille de police et le pinceau spécifiés.Initializes a new instance of the FormattedText class with the specified text, culture, flow direction, typeface, font size, and brush.

FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, Double) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, Double) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, Double) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, Double)

Initialise une nouvelle instance de la classe FormattedText avec le texte, la culture, le sens du flux, la police, la taille de police, le pinceau de premier plan et la valeur pixelsPerDip spécifiés.Initializes a new instance of the FormattedText class with the specified text, culture, flow direction, typeface, font size, foreground brush, and pixelsPerDip value.

FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution)

Initialise une nouvelle instance de la classe FormattedText, avec le texte, la culture, le sens de déroulement, le type de caractères, la taille de police, le pinceau et le comportement de substitution des nombres spécifiés.Initializes a new instance of the FormattedText class with the specified text, culture, flow direction, typeface, font size, brush, and number substitution behavior.

FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, Double) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, Double) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, Double) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, Double)

Initialise une nouvelle instance de la classe FormattedText avec le texte, la culture, le sens du flux, la police, la taille de police, le pinceau de premier plan, le comportement de substitution de nombres et la valeur pixelsPerDip spécifiés.Initializes a new instance of the FormattedText class with the specified text, culture, flow direction, typeface, font size, foreground brush, number substitution behavior, and pixelsPerDip value.

FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, TextFormattingMode) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, TextFormattingMode) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, TextFormattingMode) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, TextFormattingMode)

Initialise une nouvelle instance de la classe FormattedText, avec le texte, la culture, le sens de déroulement, le type de caractères, la taille de police, le pinceau, le comportement de substitution des nombres et le mode de mise en forme du texte spécifiés.Initializes a new instance of the FormattedText class with the specified text, culture, flow direction, typeface, font size, brush, number substitution behavior, and text formatting mode.

FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, TextFormattingMode, Double) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, TextFormattingMode, Double) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, TextFormattingMode, Double) FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, TextFormattingMode, Double)

Initialise une nouvelle instance de la classe FormattedText avec le texte, la culture, le sens du flux, la police, la taille de police, le pinceau de premier plan, le comportement de substitution de nombres et la valeur pixelsPerDip spécifiés.Initializes a new instance of the FormattedText class with the specified text, culture, flow direction, typeface, font size, foreground brush, number substitution behavior, and pixelsPerDip value.

Propriétés

Baseline Baseline Baseline Baseline

Obtient la distance du haut de la première ligne à la ligne de base de la première ligne d'un objet FormattedText.Gets the distance from the top of the first line to the baseline of the first line of a FormattedText object.

Extent Extent Extent Extent

Obtient la distance du pixel le plus élevé de la première ligne au pixel le plus bas de la dernière ligne.Gets the distance from the topmost drawn pixel of the first line to the bottommost drawn pixel of the last line.

FlowDirection FlowDirection FlowDirection FlowDirection

Obtient ou définit le FlowDirection d'un objet FormattedText.Gets or sets the FlowDirection of a FormattedText object.

Height Height Height Height

Obtient la distance du haut de la première ligne au bas de la dernière ligne de l'objet FormattedText.Gets the distance from the top of the first line to the bottom of the last line of the FormattedText object.

LineHeight LineHeight LineHeight LineHeight

Obtient la hauteur de ligne, ou interligne, entre des lignes de texte.Gets the line height, or line spacing, between lines of text.

MaxLineCount MaxLineCount MaxLineCount MaxLineCount

Obtient ou définit le nombre maximum de lignes à afficher.Gets or sets the maximum number of lines to display. Le texte qui dépasse le MaxLineCount ne sera pas affiché.Text exceeding the MaxLineCount will not be displayed.

MaxTextHeight MaxTextHeight MaxTextHeight MaxTextHeight

Obtient ou définit la hauteur maximum d'une colonne de texte.Gets or sets the maximum height of a text column.

MaxTextWidth MaxTextWidth MaxTextWidth MaxTextWidth

Obtient ou définit la largeur maximum de texte (longueur) pour une ligne de texte.Gets or sets the maximum text width (length) for a line of text.

MinWidth MinWidth MinWidth MinWidth

Obtient la plus petite largeur de texte possible pouvant pleinement accueillir le contenu de texte spécifié.Gets the smallest possible text width that can fully contain the specified text content.

OverhangAfter OverhangAfter OverhangAfter OverhangAfter

Obtient la distance du bas de la dernière ligne de texte au pixel le plus bas.Gets the distance from the bottom of the last line of text to the bottommost drawn pixel.

OverhangLeading OverhangLeading OverhangLeading OverhangLeading

Obtient la distance maximale du point d'alignement principal au pixel principal d'une ligne.Gets the maximum distance from the leading alignment point to the leading drawn pixel of a line.

OverhangTrailing OverhangTrailing OverhangTrailing OverhangTrailing

Obtient la distance maximale du pixel de fin au point d'alignement de fin d'une ligne.Gets the maximum distance from the trailing inked pixel to the trailing alignment point of a line.

PixelsPerDip PixelsPerDip PixelsPerDip PixelsPerDip

Obtient ou définit la valeur PixelsPerDip à laquelle le texte doit être affiché.Get or sets the PixelsPerDip at which the text should be rendered.

Text Text Text Text

Obtient l'affichage de la chaîne de texte.Gets the string of text to be displayed.

TextAlignment TextAlignment TextAlignment TextAlignment

Obtient ou définit l'alignement du texte dans un objet FormattedText.Gets or sets the alignment of text within a FormattedText object.

Trimming Trimming Trimming Trimming

Obtient ou définit les moyens d'indiquer l'omission de texte.Gets or sets the means by which the omission of text is indicated.

Width Width Width Width

Obtient la largeur entre le point d'alignement principal et le point de fin d'une ligne, à l'exclusion de tout espace blanc de fin.Gets the width between the leading and trailing alignment points of a line, excluding any trailing white-space characters.

WidthIncludingTrailingWhitespace WidthIncludingTrailingWhitespace WidthIncludingTrailingWhitespace WidthIncludingTrailingWhitespace

Obtient la largeur entre le point d'alignement principal et le point de fin d'une ligne, y compris tout espace blanc de fin.Gets the width between the leading and trailing alignment points of a line, including any trailing white-space characters.

Méthodes

BuildGeometry(Point) BuildGeometry(Point) BuildGeometry(Point) BuildGeometry(Point)

Renvoie un objet Geometry qui représente le texte mis en forme, dont tous les glyphes et décorations de texte.Returns a Geometry object that represents the formatted text, including all glyphs and text decorations.

BuildHighlightGeometry(Point) BuildHighlightGeometry(Point) BuildHighlightGeometry(Point) BuildHighlightGeometry(Point)

Renvoie un objet Geometry qui représente le cadre englobant de surbrillance du texte mis en forme.Returns a Geometry object that represents the highlight bounding box of the formatted text.

BuildHighlightGeometry(Point, Int32, Int32) BuildHighlightGeometry(Point, Int32, Int32) BuildHighlightGeometry(Point, Int32, Int32) BuildHighlightGeometry(Point, Int32, Int32)

Renvoie un objet Geometry qui représente le cadre englobant de surbrillance pour une sous-chaîne spécifiée du texte mis en forme.Returns a Geometry object that represents the highlight bounding box for a specified substring of the formatted text.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Inherited from Object)
GetMaxTextWidths() GetMaxTextWidths() GetMaxTextWidths() GetMaxTextWidths()

Récupère un tableau de largeurs de texte.Retrieves an array of text widths. Chaque élément dans le tableau représente la largeur maximum de texte des lignes séquentielles de texte.Each element in the array represents the maximum text width of sequential lines of text.

GetType() GetType() GetType() GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
SetCulture(CultureInfo) SetCulture(CultureInfo) SetCulture(CultureInfo) SetCulture(CultureInfo)

Définit CultureInfo pour le jeu entier de caractères dans l'objet FormattedText.Sets the CultureInfo for the entire set of characters in the FormattedText object.

SetCulture(CultureInfo, Int32, Int32) SetCulture(CultureInfo, Int32, Int32) SetCulture(CultureInfo, Int32, Int32) SetCulture(CultureInfo, Int32, Int32)

Définit les CultureInfo pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.Sets the CultureInfo for a specified subset of characters in the FormattedText object.

SetFontFamily(FontFamily) SetFontFamily(FontFamily) SetFontFamily(FontFamily) SetFontFamily(FontFamily)

Définit la famille de polices pour un objet FormattedText.Sets the font family for a FormattedText object.

SetFontFamily(FontFamily, Int32, Int32) SetFontFamily(FontFamily, Int32, Int32) SetFontFamily(FontFamily, Int32, Int32) SetFontFamily(FontFamily, Int32, Int32)

Définit la famille de polices pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.Sets the font family for a specified subset of characters in the FormattedText object.

SetFontFamily(String) SetFontFamily(String) SetFontFamily(String) SetFontFamily(String)

Définit la famille de polices pour le jeu entier de caractères dans l'objet FormattedText.Sets the font family for the entire set of characters in the FormattedText object.

SetFontFamily(String, Int32, Int32) SetFontFamily(String, Int32, Int32) SetFontFamily(String, Int32, Int32) SetFontFamily(String, Int32, Int32)

Définit la famille de polices pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.Sets the font family for a specified subset of characters in the FormattedText object.

SetFontSize(Double) SetFontSize(Double) SetFontSize(Double) SetFontSize(Double)

Définit la taille de la police pour le jeu entier de caractères dans l'objet FormattedText.Sets the font size for the entire set of characters in the FormattedText object.

SetFontSize(Double, Int32, Int32) SetFontSize(Double, Int32, Int32) SetFontSize(Double, Int32, Int32) SetFontSize(Double, Int32, Int32)

Définit la taille de la police pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.Sets the font size for a specified subset of characters in the FormattedText object.

SetFontStretch(FontStretch) SetFontStretch(FontStretch) SetFontStretch(FontStretch) SetFontStretch(FontStretch)

Définit la valeur de l'étirement de la police pour le jeu entier de caractères dans l'objet FormattedText.Sets the font stretch value for the entire set of characters in the FormattedText object.

SetFontStretch(FontStretch, Int32, Int32) SetFontStretch(FontStretch, Int32, Int32) SetFontStretch(FontStretch, Int32, Int32) SetFontStretch(FontStretch, Int32, Int32)

Définit la valeur d'étirement de la police pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.Sets the font stretch value for a specified subset of characters in the FormattedText object.

SetFontStyle(FontStyle) SetFontStyle(FontStyle) SetFontStyle(FontStyle) SetFontStyle(FontStyle)

Définit le style de la police pour le jeu entier de caractères dans l'objet FormattedText.Sets the font style for the entire set of characters in the FormattedText object.

SetFontStyle(FontStyle, Int32, Int32) SetFontStyle(FontStyle, Int32, Int32) SetFontStyle(FontStyle, Int32, Int32) SetFontStyle(FontStyle, Int32, Int32)

Définit le style de la police pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.Sets the font style for a specified subset of characters in the FormattedText object.

SetFontTypeface(Typeface) SetFontTypeface(Typeface) SetFontTypeface(Typeface) SetFontTypeface(Typeface)

Définit le type de caractères de la police pour le jeu entier de caractères dans l'objet FormattedText.Sets the font typeface for the entire set of characters in the FormattedText object.

SetFontTypeface(Typeface, Int32, Int32) SetFontTypeface(Typeface, Int32, Int32) SetFontTypeface(Typeface, Int32, Int32) SetFontTypeface(Typeface, Int32, Int32)

Définit le type de caractères de la police pour un sous-ensemble spécifié de caractères dans l'objet FormattedText object.Sets the font typeface for a specified subset of characters in the FormattedText object.

SetFontWeight(FontWeight) SetFontWeight(FontWeight) SetFontWeight(FontWeight) SetFontWeight(FontWeight)

Définit l'épaisseur de la police pour le jeu entier de caractères dans l'objet FormattedText.Sets the font weight for the entire set of characters in the FormattedText object.

SetFontWeight(FontWeight, Int32, Int32) SetFontWeight(FontWeight, Int32, Int32) SetFontWeight(FontWeight, Int32, Int32) SetFontWeight(FontWeight, Int32, Int32)

Modifie le FontWeight pour du texte spécifié dans un objet FormattedText.Changes the FontWeight for specified text within a FormattedText object.

SetForegroundBrush(Brush) SetForegroundBrush(Brush) SetForegroundBrush(Brush) SetForegroundBrush(Brush)

Modifie le premier plan Brush pour un objet FormattedText entier.Changes the foreground Brush for an entire FormattedText object.

SetForegroundBrush(Brush, Int32, Int32) SetForegroundBrush(Brush, Int32, Int32) SetForegroundBrush(Brush, Int32, Int32) SetForegroundBrush(Brush, Int32, Int32)

Modifie le Brush de premier plan pour du texte spécifié dans un objet FormattedText.Changes the foreground Brush for specified text within a FormattedText object.

SetMaxTextWidths(Double[]) SetMaxTextWidths(Double[]) SetMaxTextWidths(Double[]) SetMaxTextWidths(Double[])

Définit un tableau de largeurs maximum de texte dans le FormattedText, ligne par ligne.Sets an array of maximum text widths within the FormattedText, on a per-line basis. Chaque élément dans le tableau représente la largeur maximum de texte des lignes séquentielles de texte.Each element in the array represents the maximum text width of sequential lines of text.

SetNumberSubstitution(NumberSubstitution) SetNumberSubstitution(NumberSubstitution) SetNumberSubstitution(NumberSubstitution) SetNumberSubstitution(NumberSubstitution)

Définit le comportement de substitution de nombre pour le jeu entier de caractères dans l'objet FormattedText.Sets the number substitution behavior for the entire set of characters in the FormattedText object.

SetNumberSubstitution(NumberSubstitution, Int32, Int32) SetNumberSubstitution(NumberSubstitution, Int32, Int32) SetNumberSubstitution(NumberSubstitution, Int32, Int32) SetNumberSubstitution(NumberSubstitution, Int32, Int32)

Définit le comportement de substitution de nombre pour du texte spécifié dans un objet FormattedText.Sets the number substitution behavior for specified text within a FormattedText object.

SetTextDecorations(TextDecorationCollection) SetTextDecorations(TextDecorationCollection) SetTextDecorations(TextDecorationCollection) SetTextDecorations(TextDecorationCollection)

Définit TextDecorationCollection pour le jeu entier de caractères dans l'objet FormattedText.Sets the TextDecorationCollection for the entire set of characters in the FormattedText object.

SetTextDecorations(TextDecorationCollection, Int32, Int32) SetTextDecorations(TextDecorationCollection, Int32, Int32) SetTextDecorations(TextDecorationCollection, Int32, Int32) SetTextDecorations(TextDecorationCollection, Int32, Int32)

Définit la TextDecorationCollection pour du texte spécifié dans un objet FormattedText.Sets the TextDecorationCollection for specified text within a FormattedText object.

ToString() ToString() ToString() ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)

S’applique à

Voir aussi