PageCanvas.DrawString(String, Font, RichEditBrushBase, Rectangle, DocumentLayoutUnit) Method

Draws a custom string.

Namespace: DevExpress.XtraRichEdit.API.Layout

Assembly: DevExpress.RichEdit.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public void DrawString(
    string str,
    Font font,
    RichEditBrushBase brush,
    Rectangle bounds,
    DocumentLayoutUnit unit
)

VB.NET

Public Sub DrawString(
    str As String,
    font As Font,
    brush As RichEditBrushBase,
    bounds As Rectangle,
    unit As DocumentLayoutUnit
)

Parameters

Name	Type	Description
str	String	A custom string to be drawn.
font	Font	Sets the string’s font parameters.
brush	RichEditBrushBase	The RichEditBrushBase descendant that sets the string characters’ color and thickness.
bounds	Rectangle	Gets the location and size of the string.
unit	DocumentLayoutUnit	Specifies measurement units for the string parameters.

Remarks

When you print or export documents, document objects may appear differently from the way they look on screen. To make them look the same in both outputs, set the DocumentLayoutUnit parameter to the same DocumentLayoutUnit value as the one specified for the document layout.

Note

Using this parameter is effective only if the drawn shape has coordinates and parameters represented by absolute values – coordinates represented by relative values already have the same measurement unit as the whole document layout.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DrawString(String, Font, RichEditBrushBase, Rectangle, DocumentLayoutUnit) 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#

winforms-richedit-enable-line-numbering-and-count-document-rows/CS/LineNumberingExample/MyPagePainter.cs#L61

public override void DrawLineNumberBox(LineNumberBox lineNumberBox) {
    Canvas.DrawString(lineNumberBox.Text, lineNumberFont, new RichEditBrush(NumberingFontColor), lineNumberBox.Bounds, this.richEditControl.LayoutUnit);
}

VB.NET

winforms-richedit-enable-line-numbering-and-count-document-rows/VB/LineNumberingExample/MyPagePainter.vb#L74

Public Overrides Sub DrawLineNumberBox(ByVal lineNumberBox As LineNumberBox)
    Canvas.DrawString(lineNumberBox.Text, lineNumberFont, New RichEditBrush(NumberingFontColor), lineNumberBox.Bounds, richEditControl.LayoutUnit)
End Sub