FormattedText Class
Provides low-level control for drawing text in Windows Presentation Foundation (WPF) applications.
Assembly: PresentationCore (in PresentationCore.dll)
The FormattedText type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | FormattedText(String, CultureInfo, FlowDirection, Typeface, Double, Brush) | 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, NumberSubstitution) | 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, TextFormattingMode) | 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. |
| Name | Description | |
|---|---|---|
![]() | Baseline | Gets the distance from the top of the first line to the baseline of the first line of a FormattedText object. |
![]() | Extent | Gets the distance from the topmost drawn pixel of the first line to the bottommost drawn pixel of the last line. |
![]() | FlowDirection | Gets or sets the FlowDirection of a FormattedText object. |
![]() | Height | Gets the distance from the top of the first line to the bottom of the last line of the FormattedText object. |
![]() | LineHeight | Gets the line height, or line spacing, between lines of text. |
![]() | MaxLineCount | Gets or sets the maximum number of lines to display. Text exceeding the MaxLineCount will not be displayed. |
![]() | MaxTextHeight | Gets or sets the maximum height of a text column. |
![]() | MaxTextWidth | Gets or sets the maximum text width (length) for a line of text. |
![]() | MinWidth | Gets the smallest possible text width that can fully contain the specified text content. |
![]() | OverhangAfter | Gets the distance from the bottom of the last line of text to the bottommost drawn pixel. |
![]() | OverhangLeading | Gets the maximum distance from the leading alignment point to the leading drawn pixel of a line. |
![]() | OverhangTrailing | Gets the maximum distance from the trailing inked pixel to the trailing alignment point of a line. |
![]() | Text | Gets the string of text to be displayed. |
![]() | TextAlignment | Gets or sets the alignment of text within a FormattedText object. |
![]() | Trimming | Gets or sets the means by which the omission of text is indicated. |
![]() | Width | Gets the width between the leading and trailing alignment points of a line, excluding any trailing white-space characters. |
![]() | WidthIncludingTrailingWhitespace | Gets the width between the leading and trailing alignment points of a line, including any trailing white-space characters. |
| Name | Description | |
|---|---|---|
![]() | BuildGeometry | Returns a Geometry object that represents the formatted text, including all glyphs and text decorations. |
![]() | BuildHighlightGeometry(Point) | Returns a Geometry object that represents the highlight bounding box of the formatted text. |
![]() | BuildHighlightGeometry(Point, Int32, Int32) | Returns a Geometry object that represents the highlight bounding box for a specified substring of the formatted text. |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetMaxTextWidths | Retrieves an array of text widths. Each element in the array represents the maximum text width of sequential lines of text. |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | SetCulture(CultureInfo) | Sets the CultureInfo for the entire set of characters in the FormattedText object. |
![]() | SetCulture(CultureInfo, Int32, Int32) | Sets the CultureInfo for a specified subset of characters in the FormattedText object. |
![]() | SetFontFamily(FontFamily) | Sets the font family for a FormattedText object. |
![]() | SetFontFamily(String) | Sets the font family for the entire set of characters in the FormattedText object. |
![]() | SetFontFamily(FontFamily, Int32, Int32) | Sets the font family for a specified subset of characters in the FormattedText object. |
![]() | SetFontFamily(String, Int32, Int32) | Sets the font family for a specified subset of characters in the FormattedText object. |
![]() | SetFontSize(Double) | Sets the font size for the entire set of characters in the FormattedText object. |
![]() | SetFontSize(Double, Int32, Int32) | Sets the font size for a specified subset of characters in the FormattedText object. |
![]() | SetFontStretch(FontStretch) | Sets the font stretch value for the entire set of characters in the FormattedText object. |
![]() | SetFontStretch(FontStretch, Int32, Int32) | Sets the font stretch value for a specified subset of characters in the FormattedText object. |
![]() | SetFontStyle(FontStyle) | Sets the font style for the entire set of characters in the FormattedText object. |
![]() | SetFontStyle(FontStyle, Int32, Int32) | Sets the font style for a specified subset of characters in the FormattedText object. |
![]() | SetFontTypeface(Typeface) | Sets the font typeface for the entire set of characters in the FormattedText object. |
![]() | SetFontTypeface(Typeface, Int32, Int32) | Sets the font typeface for a specified subset of characters in the FormattedText object. |
![]() | SetFontWeight(FontWeight) | Sets the font weight for the entire set of characters in the FormattedText object. |
![]() | SetFontWeight(FontWeight, Int32, Int32) | Changes the FontWeight for specified text within a FormattedText object. |
![]() | SetForegroundBrush(Brush) | Changes the foreground Brush for an entire FormattedText object. |
![]() | SetForegroundBrush(Brush, Int32, Int32) | Changes the foreground Brush for specified text within a FormattedText object. |
![]() | SetMaxTextWidths | 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. |
![]() | SetNumberSubstitution(NumberSubstitution) | Sets the number substitution behavior for the entire set of characters in the FormattedText object. |
![]() | SetNumberSubstitution(NumberSubstitution, Int32, Int32) | Sets the number substitution behavior for specified text within a FormattedText object. |
![]() | SetTextDecorations(TextDecorationCollection) | Sets the TextDecorationCollection for the entire set of characters in the FormattedText object. |
![]() | SetTextDecorations(TextDecorationCollection, Int32, Int32) | Sets the TextDecorationCollection for specified text within a FormattedText object. |
![]() | ToString | 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.

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.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
