FormattedText Klasa

Definicja

Zapewnia kontrolę niskiego poziomu do rysowania tekstu w aplikacjach Windows Presentation Foundation (WPF).

public ref class FormattedText
public class FormattedText
type FormattedText = class
Public Class FormattedText
Dziedziczenie
FormattedText

Przykłady

Poniższy przykład tworzy obiekt, FormattedText a następnie stosuje kilka stylów formatowania do tekstu.

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

Uwagi

Obiekt FormattedText umożliwia rysowanie tekstu wielowierszowego, w którym każdy znak w tekście może być sformatowany indywidualnie. W poniższym przykładzie pokazano tekst z zastosowanymi do niego kilkoma formatami.

Tekst wyświetlany przy użyciu obiektu FormattedText Przykład sformatowanego ciągu tekstowego

Jeśli chodzi o funkcje tekstowe w WPF, jest uważany za "niski poziom", FormattedText ponieważ przetwarza tekst jako elementy graficzne. Inne aspekty tekstu w WPF obsługują tekst w kontekście kontrolek przeznaczonych do tekstu (TextBlock, TextBox), implementowanie modelu dokumentu przepływu (zobacz Flow Document Overview) lub obsługę modelu dokumentów XPS (zobacz Dokumenty w WPF).

Wiele metod ustawiania w programie FormattedText ma podobieństwa do dołączonych właściwości obsługiwanych przez TextElementprogram , ale TextElement dołączone właściwości mają zastosowanie do obsługi tekstu wyższego poziomu dla przepływu lub XPS.

Konstruktory

FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush)
Przestarzałe.

Inicjuje FormattedText nowe wystąpienie klasy z określonym tekstem, kulturą, kierunkiem przepływu, czcionką, rozmiarem czcionki i pędzlem.

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

Inicjuje nowe wystąpienie FormattedText klasy z określonym tekstem, kulturą, kierunkiem przepływu, czcionką, rozmiarem czcionki, pędzlem pierwszego planu i wartością pixelPerDip.

FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution)
Przestarzałe.

Inicjuje FormattedText nowe wystąpienie klasy z określonym tekstem, kulturą, kierunkiem przepływu, czcionką, rozmiarem czcionki, pędzlem i zachowaniem podstawienia liczb.

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

Inicjuje FormattedText nowe wystąpienie klasy z określonym tekstem, kulturą, kierunkiem przepływu, czcionką, rozmiarem czcionki, pędzlem pierwszego planu, zachowaniem podstawienia liczb i wartością pixelPerDip.

FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush, NumberSubstitution, TextFormattingMode)
Przestarzałe.

Inicjuje FormattedText nowe wystąpienie klasy z określonym tekstem, kulturą, kierunkiem przepływu, czcionką, rozmiarem czcionki, pędzlem, zachowaniem podstawienia liczb i formatowaniem tekstu.

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

Inicjuje FormattedText nowe wystąpienie klasy z określonym tekstem, kulturą, kierunkiem przepływu, czcionką, rozmiarem czcionki, pędzlem pierwszego planu, zachowaniem podstawienia liczb i wartością pixelPerDip.

Właściwości

Baseline

Pobiera odległość od góry pierwszego wiersza do linii bazowej pierwszego wiersza FormattedText obiektu.

Extent

Pobiera odległość od najbardziej narysowanego piksela pierwszego wiersza do najbardziej narysowanego dolnego piksela ostatniej linii.

FlowDirection

Pobiera lub ustawia FlowDirectionFormattedText obiekt .

Height

Pobiera odległość od góry pierwszego wiersza do dołu ostatniego wiersza FormattedText obiektu.

LineHeight

Pobiera wysokość wiersza lub odstępy między wierszami tekstu.

MaxLineCount

Pobiera lub ustawia maksymalną liczbę wierszy do wyświetlenia. Tekst przekraczający wartość MaxLineCount nie będzie wyświetlany.

MaxTextHeight

Pobiera lub ustawia maksymalną wysokość kolumny tekstowej.

MaxTextWidth

Pobiera lub ustawia maksymalną szerokość tekstu (długość) dla wiersza tekstu.

MinWidth

Pobiera najmniejszą możliwą szerokość tekstu, która może w pełni zawierać określoną zawartość tekstu.

OverhangAfter

Pobiera odległość od dołu ostatniego wiersza tekstu do najbardziej narysowanego dolnego piksela.

OverhangLeading

Pobiera maksymalną odległość od wiodącego punktu wyrównania do wiodącego narysowanego piksela linii.

OverhangTrailing

Pobiera maksymalną odległość od końcowego inkowanego piksela do końcowego punktu wyrównania linii.

PixelsPerDip

Pobierz lub ustawia element PixelPerDip, w którym ma być renderowany tekst.

Text

Pobiera ciąg tekstu do wyświetlenia.

TextAlignment

Pobiera lub ustawia wyrównanie tekstu w FormattedText obiekcie.

Trimming

Pobiera lub ustawia środki, za pomocą których wskazane jest pominięcie tekstu.

Width

Pobiera szerokość między wiodącymi i końcowymi punktami wyrównania linii, z wyłączeniem wszystkich końcowych znaków odstępu.

WidthIncludingTrailingWhitespace

Pobiera szerokość między wiodącymi i końcowymi punktami wyrównania linii, w tym wszelkie końcowe znaki odstępu.

Metody

BuildGeometry(Point)

Geometry Zwraca obiekt reprezentujący sformatowany tekst, w tym wszystkie glify i dekoracje tekstu.

BuildHighlightGeometry(Point)

Geometry Zwraca obiekt reprezentujący pole ograniczenia wyróżnienia sformatowanego tekstu.

BuildHighlightGeometry(Point, Int32, Int32)

Geometry Zwraca obiekt reprezentujący pole ograniczenia wyróżnienia dla określonego podciągu sformatowanego tekstu.

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.

(Odziedziczone po Object)
GetHashCode()

Służy jako domyślna funkcja skrótu.

(Odziedziczone po Object)
GetMaxTextWidths()

Pobiera tablicę szerokości tekstu. Każdy element w tablicy reprezentuje maksymalną szerokość tekstu sekwencyjnego wiersza tekstu.

GetType()

Type Pobiera wartość bieżącego wystąpienia.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy płytkią kopię bieżącego Objectelementu .

(Odziedziczone po Object)
SetCulture(CultureInfo)

Ustawia dla CultureInfo całego zestawu znaków w FormattedText obiekcie .

SetCulture(CultureInfo, Int32, Int32)

Ustawia dla CultureInfo określonego podzestawu znaków w FormattedText obiekcie.

SetFontFamily(FontFamily)

Ustawia rodzinę FormattedText czcionek dla obiektu.

SetFontFamily(FontFamily, Int32, Int32)

Ustawia rodzinę czcionek dla określonego podzestawu znaków w FormattedText obiekcie.

SetFontFamily(String)

Ustawia rodzinę czcionek dla całego zestawu znaków w FormattedText obiekcie.

SetFontFamily(String, Int32, Int32)

Ustawia rodzinę czcionek dla określonego podzestawu znaków w FormattedText obiekcie.

SetFontSize(Double)

Ustawia rozmiar czcionki dla całego zestawu znaków w FormattedText obiekcie.

SetFontSize(Double, Int32, Int32)

Ustawia rozmiar czcionki dla określonego podzestawu znaków w FormattedText obiekcie.

SetFontStretch(FontStretch)

Ustawia wartość rozciągnięcia czcionki dla całego zestawu znaków w FormattedText obiekcie.

SetFontStretch(FontStretch, Int32, Int32)

Ustawia wartość rozciągnięcia czcionki dla określonego podzestawu znaków w FormattedText obiekcie.

SetFontStyle(FontStyle)

Ustawia styl czcionki dla całego zestawu znaków w FormattedText obiekcie.

SetFontStyle(FontStyle, Int32, Int32)

Ustawia styl czcionki dla określonego podzestawu znaków w FormattedText obiekcie.

SetFontTypeface(Typeface)

Ustawia krój czcionki dla całego zestawu znaków w FormattedText obiekcie.

SetFontTypeface(Typeface, Int32, Int32)

Ustawia czcionkę kroju czcionki dla określonego podzestawu znaków w FormattedText obiekcie.

SetFontWeight(FontWeight)

Ustawia wagę czcionki dla całego zestawu znaków w FormattedText obiekcie.

SetFontWeight(FontWeight, Int32, Int32)

Zmienia wartość FontWeight dla określonego FormattedText tekstu w obiekcie.

SetForegroundBrush(Brush)

Zmienia pierwszy plan Brush dla całego FormattedText obiektu.

SetForegroundBrush(Brush, Int32, Int32)

Zmienia pierwszy plan Brush dla określonego FormattedText tekstu w obiekcie.

SetMaxTextWidths(Double[])

Ustawia tablicę maksymalnej szerokości tekstu w obiekcie FormattedTextna podstawie wiersza. Każdy element w tablicy reprezentuje maksymalną szerokość tekstu sekwencyjnego wiersza tekstu.

SetNumberSubstitution(NumberSubstitution)

Ustawia zachowanie podstawienia liczb dla całego zestawu znaków w FormattedText obiekcie.

SetNumberSubstitution(NumberSubstitution, Int32, Int32)

Ustawia zachowanie podstawienia liczb dla określonego FormattedText tekstu w obiekcie.

SetTextDecorations(TextDecorationCollection)

Ustawia dla TextDecorationCollection całego zestawu znaków w FormattedText obiekcie .

SetTextDecorations(TextDecorationCollection, Int32, Int32)

Ustawia dla TextDecorationCollection określonego FormattedText tekstu w obiekcie.

ToString()

Zwraca ciąg reprezentujący bieżący obiekt.

(Odziedziczone po Object)

Dotyczy

Zobacz też