PageCanvas.DrawString(String, Font, RichEditBrushBase, Point) Method

Places a custom string.

Namespace: DevExpress.XtraRichEdit.API.Layout

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

public void DrawString(
    string str,
    Font font,
    RichEditBrushBase brush,
    Point point
)

VB.NET

Public Sub DrawString(
    str As String,
    font As Font,
    brush As RichEditBrushBase,
    point As Point
)

Parameters

Name	Type	Description
str	String	A custom string to be drawn.
font	Font	Sets the custom string’s font parameters.
brush	RichEditBrushBase	The RichEditBrushBase object that sets the color and thickness of the string characters.
point	Point	Sets the string’s start point coordinates.

Example

This code snippet illustrates the implementation of the PageCanvas.DrawString method. It draws a colored text string over the floating picture.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/layout-api-simple-example-t245818

MyLayoutPainter.vb

Public Overrides Sub DrawFloatingPicture(ByVal floatingPicture As LayoutFloatingPicture)
    If Form1.customDrawImage = True Then
        Dim bounds As Rectangle = floatingPicture.Bounds
        Dim startPoint As New Point(bounds.X + 10, bounds.Y + bounds.Height - 40)
        Dim pEn As New RichEditPen(Color.Coral)
        pEn.Thickness = 3
        pEn.DashStyle = RichEditDashStyle.Dash
        Canvas.DrawEllipse(pEn, bounds)
        Canvas.DrawString("Approved", New Font("Courier New", 26), New RichEditBrush(Color.DarkMagenta), startPoint)
    Else
        MyBase.DrawFloatingPicture(floatingPicture)
    End If
End Sub

MyLayoutPainter.cs

public override void DrawFloatingPicture(LayoutFloatingPicture floatingPicture)
{
    if (Form1.customDrawImage == true)
    {
        Rectangle bounds = floatingPicture.Bounds;
        Point startPoint = new Point(bounds.X + 10, bounds.Y + bounds.Height - 40);
        RichEditPen pEn = new RichEditPen(Color.Coral);
        pEn.Thickness = 3;
        pEn.DashStyle = RichEditDashStyle.Dash;
        Canvas.DrawEllipse(pEn, bounds);
        Canvas.DrawString("Approved", new Font("Courier New", 26), new RichEditBrush(Color.DarkMagenta), startPoint);
    }
    else
        base.DrawFloatingPicture(floatingPicture);
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DrawString(String, Font, RichEditBrushBase, Point) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

wpf-rich-editor-layout-api-simple-example-t250783/CS/LayoutAPISimpleExample/MyLayoutPainter.cs#L31

    Canvas.DrawEllipse(pEn, bounds);
    Canvas.DrawString("Approved", new Font("Courier New", 26), new RichEditBrush(System.Windows.Media.Color.FromRgb(139, 0, 139)), startPoint);
}

how-to-display-specific-grayed-text-nulltext-in-richeditcontrol-when-a-document-is-empty-t430224/CS/RichNullText/Form1.cs#L44

if (control.Document.IsEmpty && !control.Focused)
    this.Canvas.DrawString("NullText", new Font("Calibri", 11), new RichEditBrush(Color.Gray), page.Bounds.Location);
base.DrawPage(page);

layout-api-simple-example-t245818/CS/LayoutApiSimpleExample/MyLayoutPainter.cs#L35

    Canvas.DrawEllipse(pEn, bounds);
    Canvas.DrawString("Approved", new Font("Courier New", 26), new RichEditBrush(Color.DarkMagenta), startPoint);
}

VB.NET

wpf-rich-editor-layout-api-simple-example-t250783/VB/LayoutAPISimpleExample/MyLayoutPainter.vb#L27

    Canvas.DrawEllipse(pEn, bounds)
    Canvas.DrawString("Approved", New Font("Courier New", 26), New RichEditBrush(System.Windows.Media.Color.FromRgb(139, 0, 139)), startPoint)
Else

how-to-display-specific-grayed-text-nulltext-in-richeditcontrol-when-a-document-is-empty-t430224/VB/RichNullText/Form1.vb#L40

If control.Document.IsEmpty AndAlso (Not control.Focused) Then
    Me.Canvas.DrawString("NullText", New Font("Calibri", 11), New RichEditBrush(Color.Gray), page.Bounds.Location)
End If

layout-api-simple-example-t245818/VB/LayoutApiSimpleExample/MyLayoutPainter.vb#L31

    Canvas.DrawEllipse(pEn, bounds)
    Canvas.DrawString("Approved", New Font("Courier New", 26), New RichEditBrush(Color.DarkMagenta), startPoint)
Else