FormattedText.SetForegroundBrush Method

Definition

Namespace:

System.Windows.Media

Assembly:

PresentationCore.dll

Changes the foreground brush used for drawing text.

Overloads

SetForegroundBrush(Brush, Int32, Int32)	Changes the foreground Brush 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.

public:
 void SetForegroundBrush(System::Windows::Media::Brush ^ foregroundBrush, int startIndex, int count);

public void SetForegroundBrush (System.Windows.Media.Brush foregroundBrush, int startIndex, int count);

member this.SetForegroundBrush : System.Windows.Media.Brush * int * int -> unit

Public Sub SetForegroundBrush (foregroundBrush As Brush, startIndex As Integer, count As Integer)

Parameters

foregroundBrush

Brush

The brush to use for the text foreground.

startIndex

Int32

The start index of the initial character to apply the foreground brush to.

count

Int32

The number of characters to apply the foreground brush to.

Examples

The following example creates a FormattedText object and then applies several formatting styles to the text, including SetForegroundBrush.

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

Remarks

To set the foreground brush for the entire text string, use the SetForegroundBrush method.

SetForegroundBrush(Brush)

Changes the foreground Brush for an entire FormattedText object.

public:
 void SetForegroundBrush(System::Windows::Media::Brush ^ foregroundBrush);

public void SetForegroundBrush (System.Windows.Media.Brush foregroundBrush);

member this.SetForegroundBrush : System.Windows.Media.Brush -> unit

Public Sub SetForegroundBrush (foregroundBrush As Brush)

Parameters

foregroundBrush

Brush

The brush to use for the text foreground.

Remarks

This method sets the foreground brush for the entire text string. To set the foreground brush for a subset of the text string, use the SetForegroundBrush(Brush, Int32, Int32) method.