PageCanvas.DrawRectangle(RichEditPenBase, Rectangle) Method

Draws a custom rectangle.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

public void DrawRectangle(
    RichEditPenBase pen,
    Rectangle bounds
)

VB.NET

Public Sub DrawRectangle(
    pen As RichEditPenBase,
    bounds As Rectangle
)

Parameters

Name	Type	Description
pen	RichEditPenBase	The RichEditPenBase descendant that sets the outline color and thickness.
bounds	Rectangle	Sets the rectangle’s location and size.

Remarks

To set the line style, use the RichEditPenBase.DashStyle method.

Example

This code snippet illustrates the implementation of the PageCanvas.DrawRectangle and PageCanvas.DrawLine methods. They draw a color rectangle and two crossed lines in place of the inline pictures.

View Example

MyLayoutPainter.vb

Public Overrides Sub DrawInlinePictureBox(ByVal inlinePictureBox As InlinePictureBox)
    If Form1.customDrawPicture = True Then
        Dim Ebounds As Rectangle = inlinePictureBox.Bounds
        Dim pen As New RichEditPen(Color.Maroon, 2)
        pen.DashStyle = RichEditDashStyle.Dot
        Canvas.DrawLine(pen, New Point(Ebounds.X, Ebounds.Y + Ebounds.Height), New Point(Ebounds.X + Ebounds.Width, Ebounds.Y))
        Canvas.DrawLine(pen, New Point(Ebounds.X, Ebounds.Y), New Point(Ebounds.X + Ebounds.Width, Ebounds.Y + Ebounds.Height))
        Dim inlineRect As New Rectangle(Ebounds.X, Ebounds.Y, Ebounds.Width, Ebounds.Height)
        Canvas.DrawRectangle(New RichEditPen(Color.Aquamarine, 4), inlineRect)
    Else
        MyBase.DrawInlinePictureBox(inlinePictureBox)
    End If
End Sub

MyLayoutPainter.cs

public override void DrawInlinePictureBox(InlinePictureBox inlinePictureBox)
{
    if (Form1.customDrawPicture == true)
    {
        Rectangle Ebounds = inlinePictureBox.Bounds;
        RichEditPen pen = new RichEditPen(Color.Maroon, 2);
        pen.DashStyle = RichEditDashStyle.Dot;
        Canvas.DrawLine(pen, new Point(Ebounds.X, Ebounds.Y + Ebounds.Height), new Point(Ebounds.X + Ebounds.Width, Ebounds.Y));
        Canvas.DrawLine(pen, new Point(Ebounds.X, Ebounds.Y), new Point(Ebounds.X + Ebounds.Width, Ebounds.Y + Ebounds.Height));
        Rectangle inlineRect = new Rectangle(Ebounds.X, Ebounds.Y, Ebounds.Width, Ebounds.Height);
        Canvas.DrawRectangle(new RichEditPen(Color.Aquamarine, 4), inlineRect);
    }
    else
        base.DrawInlinePictureBox(inlinePictureBox);
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DrawRectangle(RichEditPenBase, Rectangle) 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-layout-api/CS/LayoutApiSimpleExample/MyLayoutPainter.cs#L18

{
    Canvas.DrawRectangle(new RichEditPen(Color.FromArgb(141, 179, 226)), plainTextBox.Bounds);
}

VB.NET

winforms-richedit-layout-api/VB/LayoutApiSimpleExample/MyLayoutPainter.vb#L15

If Form1.customDrawText = True Then
    Canvas.DrawRectangle(New RichEditPen(Color.FromArgb(141, 179, 226)), plainTextBox.Bounds)
Else