FormattedText Class

 

Provides low-level control for drawing text in Windows Presentation Foundation (WPF) applications.

Namespace:   System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)

System.Object
  System.Windows.Media.FormattedText

public class FormattedText

NameDescription
System_CAPS_pubmethodFormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush)

Obsolete.Initializes a new instance of the FormattedText class with the specified text, culture, flow direction, typeface, font size, and brush.

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

Initializes a new instance of the FormattedText class with the specified text, culture, flow direction, typeface, font size, foreground brush, and pixelsPerDip value.

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

Obsolete.Initializes a new instance of the FormattedText class with the specified text, culture, flow direction, typeface, font size, brush, and number substitution behavior.

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

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.

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

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

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

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.

NameDescription
System_CAPS_pubpropertyBaseline

Gets the distance from the top of the first line to the baseline of the first line of a FormattedText object.

System_CAPS_pubpropertyExtent

Gets the distance from the topmost drawn pixel of the first line to the bottommost drawn pixel of the last line.

System_CAPS_pubpropertyFlowDirection

Gets or sets the FlowDirection of a FormattedText object.

System_CAPS_pubpropertyHeight

Gets the distance from the top of the first line to the bottom of the last line of the FormattedText object.

System_CAPS_pubpropertyLineHeight

Gets the line height, or line spacing, between lines of text.

System_CAPS_pubpropertyMaxLineCount

Gets or sets the maximum number of lines to display. Text exceeding the MaxLineCount will not be displayed.

System_CAPS_pubpropertyMaxTextHeight

Gets or sets the maximum height of a text column.

System_CAPS_pubpropertyMaxTextWidth

Gets or sets the maximum text width (length) for a line of text.

System_CAPS_pubpropertyMinWidth

Gets the smallest possible text width that can fully contain the specified text content.

System_CAPS_pubpropertyOverhangAfter

Gets the distance from the bottom of the last line of text to the bottommost drawn pixel.

System_CAPS_pubpropertyOverhangLeading

Gets the maximum distance from the leading alignment point to the leading drawn pixel of a line.

System_CAPS_pubpropertyOverhangTrailing

Gets the maximum distance from the trailing inked pixel to the trailing alignment point of a line.

System_CAPS_pubpropertyPixelsPerDip

Get or sets the PixelsPerDip at which the text should be rendered.

System_CAPS_pubpropertyText

Gets the string of text to be displayed.

System_CAPS_pubpropertyTextAlignment

Gets or sets the alignment of text within a FormattedText object.

System_CAPS_pubpropertyTrimming

Gets or sets the means by which the omission of text is indicated.

System_CAPS_pubpropertyWidth

Gets the width between the leading and trailing alignment points of a line, excluding any trailing white-space characters.

System_CAPS_pubpropertyWidthIncludingTrailingWhitespace

Gets the width between the leading and trailing alignment points of a line, including any trailing white-space characters.

NameDescription
System_CAPS_pubmethodBuildGeometry(Point)

Returns a Geometry object that represents the formatted text, including all glyphs and text decorations.

System_CAPS_pubmethodBuildHighlightGeometry(Point)

Returns a Geometry object that represents the highlight bounding box of the formatted text.

System_CAPS_pubmethodBuildHighlightGeometry(Point, Int32, Int32)

Returns a Geometry object that represents the highlight bounding box for a specified substring of the formatted text.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetMaxTextWidths()

Retrieves an array of text widths. Each element in the array represents the maximum text width of sequential lines of text.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodSetCulture(CultureInfo)

Sets the CultureInfo for the entire set of characters in the FormattedText object.

System_CAPS_pubmethodSetCulture(CultureInfo, Int32, Int32)

Sets the CultureInfo for a specified subset of characters in the FormattedText object.

System_CAPS_pubmethodSetFontFamily(FontFamily)

Sets the font family for a FormattedText object.

System_CAPS_pubmethodSetFontFamily(FontFamily, Int32, Int32)

Sets the font family for a specified subset of characters in the FormattedText object.

System_CAPS_pubmethodSetFontFamily(String)

Sets the font family for the entire set of characters in the FormattedText object.

System_CAPS_pubmethodSetFontFamily(String, Int32, Int32)

Sets the font family for a specified subset of characters in the FormattedText object.

System_CAPS_pubmethodSetFontSize(Double)

Sets the font size for the entire set of characters in the FormattedText object.

System_CAPS_pubmethodSetFontSize(Double, Int32, Int32)

Sets the font size for a specified subset of characters in the FormattedText object.

System_CAPS_pubmethodSetFontStretch(FontStretch)

Sets the font stretch value for the entire set of characters in the FormattedText object.

System_CAPS_pubmethodSetFontStretch(FontStretch, Int32, Int32)

Sets the font stretch value for a specified subset of characters in the FormattedText object.

System_CAPS_pubmethodSetFontStyle(FontStyle)

Sets the font style for the entire set of characters in the FormattedText object.

System_CAPS_pubmethodSetFontStyle(FontStyle, Int32, Int32)

Sets the font style for a specified subset of characters in the FormattedText object.

System_CAPS_pubmethodSetFontTypeface(Typeface)

Sets the font typeface for the entire set of characters in the FormattedText object.

System_CAPS_pubmethodSetFontTypeface(Typeface, Int32, Int32)

Sets the font typeface for a specified subset of characters in the FormattedText object.

System_CAPS_pubmethodSetFontWeight(FontWeight)

Sets the font weight for the entire set of characters in the FormattedText object.

System_CAPS_pubmethodSetFontWeight(FontWeight, Int32, Int32)

Changes the FontWeight for specified text within a FormattedText object.

System_CAPS_pubmethodSetForegroundBrush(Brush)

Changes the foreground Brush for an entire FormattedText object.

System_CAPS_pubmethodSetForegroundBrush(Brush, Int32, Int32)

Changes the foreground Brush for specified text within a FormattedText object.

System_CAPS_pubmethodSetMaxTextWidths(Double[])

Sets an array of maximum text widths within the FormattedText, on a per-line basis. Each element in the array represents the maximum text width of sequential lines of text.

System_CAPS_pubmethodSetNumberSubstitution(NumberSubstitution)

Sets the number substitution behavior for the entire set of characters in the FormattedText object.

System_CAPS_pubmethodSetNumberSubstitution(NumberSubstitution, Int32, Int32)

Sets the number substitution behavior for specified text within a FormattedText object.

System_CAPS_pubmethodSetTextDecorations(TextDecorationCollection)

Sets the TextDecorationCollection for the entire set of characters in the FormattedText object.

System_CAPS_pubmethodSetTextDecorations(TextDecorationCollection, Int32, Int32)

Sets the TextDecorationCollection for specified text within a FormattedText object.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The FormattedText object allows you to draw multi-line text, in which each character in the text can be individually formatted. The following example shows text that has several formats applied to it.

Text displayed using FormattedText object

Example of a formatted text string

In terms of text features in WPF, FormattedText is considered "low-level" because it processes text as graphical elements. Other aspects of text in WPF 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 XPS document model (see Documents in WPF).

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

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));
}

.NET Framework
Available since 3.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: