FormattedText Classe

Référence

Définition

Espace de noms:: System.Windows.Media

Assembly:: PresentationCore.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Fournit un contrôle de bas niveau pour dessiner du texte dans les applications WPF (Windows Presentation Foundation).

public ref class FormattedText

public class FormattedText

type FormattedText = class

Public Class FormattedText

Héritage: Object
FormattedText

Exemples

L’exemple suivant crée un FormattedText objet, puis applique plusieurs styles de mise en forme au texte.

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’objet FormattedText vous permet de dessiner du texte à plusieurs lignes, dans lequel chaque caractère du texte peut être mis en forme individuellement. L’exemple suivant montre un texte auquel plusieurs formats sont appliqués.

Texte affiché à l’aide de l’objet FormattedText Exemple de chaîne de texte mise en forme

En termes de fonctionnalités de texte dans WPF, FormattedText est considéré comme « de bas niveau », car il traite le texte en tant qu’éléments graphiques. D’autres aspects du texte dans WPF gèrent le texte dans le contexte des contrôles dédiés au texte (TextBlock, TextBox), implémentez le modèle de document de flux (voir Flow Vue d’ensemble du document) ou prenez en charge le modèle de document XPS (voir Documents dans WPF).

La plupart des méthodes FormattedText setter ont des similitudes avec les propriétés jointes prises en charge TextElementpar , mais les TextElement propriétés jointes s’appliquent à la prise en charge du texte de niveau supérieur pour le flux ou XPS.

Constructeurs

FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush)	Obsolète. 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.
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.
FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution)	Obsolète. 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.
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.
FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, TextFormattingMode)	Obsolète. 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.
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.

Propriétés

Baseline	Obtient la distance du haut de la première ligne à la ligne de base de la première ligne d'un objet FormattedText.
Extent	Obtient la distance du pixel le plus élevé de la première ligne au pixel le plus bas de la dernière ligne.
FlowDirection	Obtient ou définit le FlowDirection d'un objet FormattedText.
Height	Obtient la distance du haut de la première ligne au bas de la dernière ligne de l'objet FormattedText.
LineHeight	Obtient la hauteur de ligne, ou interligne, entre des lignes de texte.
MaxLineCount	Obtient ou définit le nombre maximum de lignes à afficher. Le texte qui dépasse le MaxLineCount ne sera pas affiché.
MaxTextHeight	Obtient ou définit la hauteur maximum d'une colonne de texte.
MaxTextWidth	Obtient ou définit la largeur maximum de texte (longueur) pour une ligne de texte.
MinWidth	Obtient la plus petite largeur de texte possible pouvant pleinement accueillir le contenu de texte spécifié.
OverhangAfter	Obtient la distance du bas de la dernière ligne de texte au pixel le plus bas.
OverhangLeading	Obtient la distance maximale du point d'alignement principal au pixel principal d'une ligne.
OverhangTrailing	Obtient la distance maximale du pixel de fin au point d'alignement de fin d'une ligne.
PixelsPerDip	Obtient ou définit la valeur PixelsPerDip à laquelle le texte doit être affiché.
Text	Obtient l'affichage de la chaîne de texte.
TextAlignment	Obtient ou définit l'alignement du texte dans un objet FormattedText.
Trimming	Obtient ou définit les moyens d'indiquer l'omission de texte.
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.
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.

Méthodes

BuildGeometry(Point)	Renvoie un objet Geometry qui représente le texte mis en forme, dont tous les glyphes et décorations de texte.
BuildHighlightGeometry(Point)	Renvoie un objet Geometry qui représente le cadre englobant de surbrillance du texte mis en forme.
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.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetMaxTextWidths()	Récupère un tableau de largeurs de texte. Chaque élément dans le tableau représente la largeur maximum de texte des lignes séquentielles de texte.
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
SetCulture(CultureInfo)	Définit CultureInfo pour le jeu entier de caractères dans l'objet FormattedText.
SetCulture(CultureInfo, Int32, Int32)	Définit les CultureInfo pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.
SetFontFamily(FontFamily)	Définit la famille de polices pour un objet FormattedText.
SetFontFamily(FontFamily, Int32, Int32)	Définit la famille de polices pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.
SetFontFamily(String)	Définit la famille de polices pour le jeu entier de caractères dans l'objet FormattedText.
SetFontFamily(String, Int32, Int32)	Définit la famille de polices pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.
SetFontSize(Double)	Définit la taille de la police pour le jeu entier de caractères dans l'objet FormattedText.
SetFontSize(Double, Int32, Int32)	Définit la taille de la police pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.
SetFontStretch(FontStretch)	Définit la valeur de l'étirement de la police pour le jeu entier de caractères dans l'objet FormattedText.
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.
SetFontStyle(FontStyle)	Définit le style de la police pour le jeu entier de caractères dans l'objet FormattedText.
SetFontStyle(FontStyle, Int32, Int32)	Définit le style de la police pour un sous-ensemble spécifié de caractères dans l'objet FormattedText.
SetFontTypeface(Typeface)	Définit le type de caractères de la police pour le jeu entier de caractères dans l'objet FormattedText.
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.
SetFontWeight(FontWeight)	Définit l'épaisseur de la police pour le jeu entier de caractères dans l'objet FormattedText.
SetFontWeight(FontWeight, Int32, Int32)	Modifie le FontWeight pour du texte spécifié dans un objet FormattedText.
SetForegroundBrush(Brush)	Modifie le premier plan Brush pour un objet FormattedText entier.
SetForegroundBrush(Brush, Int32, Int32)	Modifie le Brush de premier plan pour du texte spécifié dans un objet FormattedText.
SetMaxTextWidths(Double[])	Définit un tableau de largeurs maximum de texte dans le FormattedText, ligne par ligne. Chaque élément dans le tableau représente la largeur maximum de texte des lignes séquentielles de texte.
SetNumberSubstitution(NumberSubstitution)	Définit le comportement de substitution de nombre pour le jeu entier de caractères dans l'objet FormattedText.
SetNumberSubstitution(NumberSubstitution, Int32, Int32)	Définit le comportement de substitution de nombre pour du texte spécifié dans un objet FormattedText.
SetTextDecorations(TextDecorationCollection)	Définit TextDecorationCollection pour le jeu entier de caractères dans l'objet FormattedText.
SetTextDecorations(TextDecorationCollection, Int32, Int32)	Définit la TextDecorationCollection pour du texte spécifié dans un objet FormattedText.
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

S’applique à

Partager via