PageCanvas.DrawLines(RichEditPenBase, Point[]) Method

Draws a custom set of lines.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public void DrawLines(
    RichEditPenBase pen,
    Point[] points
)

VB.NET

Public Sub DrawLines(
    pen As RichEditPenBase,
    points As Point()
)

Parameters

Name	Type	Description
pen	RichEditPenBase	The RichEditPenBase descendant that sets the lines’ color and thickness.
points	Point[]	The array of points locating the lines.

Remarks

This method draws the lines so that the end of the first line is the beginning of the next one.

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

Example

This code snippet illustrates the implementation of the PageCanvas.DrawLines method. It draws a set of lines forming a star in place of the text box.

View Example

MyLayoutPainter.vb

Public Overrides Sub DrawTextBox(ByVal textBox As LayoutTextBox)
    If Form1.customDrawTextBox = True Then
        Dim StarPoints() As Point = { _
            New Point(textBox.Bounds.X+textBox.Bounds.Width\2,textBox.Bounds.Y), _
            New Point(textBox.Bounds.X+textBox.Bounds.Width,textBox.Bounds.Y+textBox.Bounds.Height), _
            New Point(textBox.Bounds.X,textBox.Bounds.Y+textBox.Bounds.Height\2), _
            New Point(textBox.Bounds.X+textBox.Bounds.Width,textBox.Bounds.Y+textBox.Bounds.Height\2), _
            New Point(textBox.Bounds.X,textBox.Bounds.Y+textBox.Bounds.Height), _
            New Point(textBox.Bounds.X+textBox.Bounds.Width\2,textBox.Bounds.Y) _
        }
        Canvas.DrawLines(New RichEditPen(Color.HotPink, 3), StarPoints)
    Else
        MyBase.DrawTextBox(textBox)
    End If
End Sub

MyLayoutPainter.cs

public override void DrawTextBox(LayoutTextBox textBox)
{
    if (Form1.customDrawTextBox == true)
    {
        Point[] StarPoints =
            {
        new Point(textBox.Bounds.X+textBox.Bounds.Width/2,textBox.Bounds.Y),
        new Point(textBox.Bounds.X+textBox.Bounds.Width,textBox.Bounds.Y+textBox.Bounds.Height),
        new Point(textBox.Bounds.X,textBox.Bounds.Y+textBox.Bounds.Height/2),
        new Point(textBox.Bounds.X+textBox.Bounds.Width,textBox.Bounds.Y+textBox.Bounds.Height/2),
        new Point(textBox.Bounds.X,textBox.Bounds.Y+textBox.Bounds.Height),
        new Point(textBox.Bounds.X+textBox.Bounds.Width/2,textBox.Bounds.Y)
            };
        Canvas.DrawLines(new RichEditPen(Color.HotPink, 3), StarPoints);
    }
    else
        base.DrawTextBox(textBox);
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DrawLines(RichEditPenBase, 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#

winforms-richedit-layout-api/CS/LayoutApiSimpleExample/MyLayoutPainter.cs#L94

        };
    Canvas.DrawLines(new RichEditPen(Color.HotPink, 30), StarPoints);
}

VB.NET

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

    }
    Canvas.DrawLines(New RichEditPen(Color.HotPink, 30), StarPoints)
Else