RichEditCustomMarkDrawEventArgs.VisualInfoCollection Property

Provides access to information required to visualize custom marks.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.2.dll

NuGet Package: DevExpress.Win.RichEdit

Declaration

C#

public CustomMarkVisualInfoCollection VisualInfoCollection { get; }

VB.NET

Public ReadOnly Property VisualInfoCollection As CustomMarkVisualInfoCollection

Property Value

Type	Description
DevExpress.XtraRichEdit.Layout.Export.CustomMarkVisualInfoCollection	A DevExpress.XtraRichEdit.Layout.Export.CustomMarkVisualInfoCollection collection containing custom marks visual info.

Remarks

The UserData property of the CustomMarkVisualInfo object, contained in the collection, provides custom data that may be used to visualize custom marks. These data are attached when the custom mark is created.

To create a custom mark in the document, use the CustomMarkCollection.Create method.

To obtain a corresponding CustomMark object by its visual info, use the ReadOnlyCustomMarkCollection.GetByVisualInfo method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the VisualInfoCollection property.

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#

how-to-highlight-all-found-word-entries-in-a-document-t202228/CS/RichEdit/Form1.cs#L31

void richEditControl1_CustomMarkDraw(object sender, RichEditCustomMarkDrawEventArgs e) {
    if (e.VisualInfoCollection != null) {
        Dictionary<DocumentRange, Rectangle> table = new Dictionary<DocumentRange, Rectangle>();

how-to-draw-custom-marks-in-the-document-e2590/CS/Form1.cs#L31

{
    foreach (CustomMarkVisualInfo info in e.VisualInfoCollection)
    {

VB.NET

how-to-draw-custom-marks-in-the-document-e2590/VB/Form1.vb#L33

Private Sub richEditControl1_CustomMarkDraw(ByVal sender As Object, ByVal e As RichEditCustomMarkDrawEventArgs) Handles richEditControl1.CustomMarkDraw
    For Each info As CustomMarkVisualInfo In e.VisualInfoCollection
        Dim doc As Document = richEditControl1.Document