PageCanvas.DrawLine(RichEditPenBase, Int32, Int32, Int32, Int32) Method

Draws a custom line.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

Declaration

C#

public void DrawLine(
    RichEditPenBase pen,
    int x1,
    int y1,
    int x2,
    int y2
)

VB.NET

Public Sub DrawLine(
    pen As RichEditPenBase,
    x1 As Integer,
    y1 As Integer,
    x2 As Integer,
    y2 As Integer
)

Parameters

Name	Type	Description
pen	RichEditPenBase	The RichEditPenBase descendant that sets the line’s color and thickness.
x1	Int32	Sets the x-coordinate of the line’s start point.
y1	Int32	Sets the y-coordinate of the line’s start point.
x2	Int32	Sets the x-coordinate of the line’s end point
y2	Int32	Sets the y-coordinate of the line’s end point

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.

Note

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

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);
}