DocumentIterator Class

Iterates over document elements.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

public class DocumentIterator :
    IEnumerator<IDocumentElement>,
    IDisposable,
    IEnumerator

VB.NET

Public Class DocumentIterator
    Implements IEnumerator(Of IDocumentElement),
               IDisposable,
               IEnumerator

C#

public class DocumentIterator :
    IEnumerator<IDocumentElement>,
    IEnumerator,
    IDisposable

VB.NET

Public Class DocumentIterator
    Implements IEnumerator(Of IDocumentElement),
               IEnumerator,
               IDisposable

Related API Members

The following members accept/return DocumentIterator objects:

• DocumentCommentElement.GetIterator(Boolean)
• DocumentTextBox.GetIterator(Boolean)

Remarks

The DocumentIterator object enables you to iterate over document elements in a specified document range. To accomplish this, create a new DocumentIterator instance and call its DocumentIterator.MoveNext method until it returns false. For each step, the current document element is obtained with the DocumentIterator.Current property.

This example creates a DocumentIterator instance for the current document and calls its DocumentIterator.MoveNext method to iterate over document elements. A Visitor pattern is implemented to process a document element. The implementation is done by calling each element’s IDocumentElement.Accept method with the MyVisitor object instance as a parameter. MyVisitor object implements the IDocumentVisitor interface and overrides its IDocumentVisitor.Visit methods to perform required actions when an iterator encounters a certain document element ( an instance of the class inherited form the DocumentElementBase class).

View Example

Form1.cs

MyVisitor visitor = new MyVisitor();
DocumentIterator iterator = new DocumentIterator(richEditControl1.Document, true);
while (iterator.MoveNext())
    iterator.Current.Accept(visitor);
memoEdit1.Text = visitor.Text;

Form1.vb

Dim visitor As New MyVisitor()
Dim iterator As New DocumentIterator(richEditControl1.Document, True)
Do While iterator.MoveNext()
    iterator.Current.Accept(visitor)
Loop
memoEdit1.Text = visitor.Text

Related GitHub Examples

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

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-use-the-document-iterator-object-to-iterate-over-document-elements-t384347/CS/DocumentIteratorExample/Form1.cs#L22

MyVisitor visitor = new MyVisitor();
DocumentIterator iterator = new DocumentIterator(richEditControl1.Document, true);
while (iterator.MoveNext())

how-to-use-document-iterator-to-obtain-a-list-of-fonts-that-are-used-in-a-document-t438475/CS/Form1.cs#L27

MyVisitor visitor = new MyVisitor();
DocumentIterator iterator = new DocumentIterator(richEditControl1.Document, true);
while (iterator.MoveNext())

how-to-emulate-the-ms-word-information-status-bar-when-using-richeditcontrol-t467150/CS/WindowsFormsApplication1/Form1.cs#L80

{
    DocumentIterator iterator = new DocumentIterator(richEdit.Document, true);
    StaticsticsVisitor visitor = new StaticsticsVisitor();

how-to-use-documentiterator-to-export-a-rich-edit-document-in-a-custom-document-format-t632549/CS/DocumentIteratorExample/Form1.cs#L21

{
    DocumentIterator iterator = new DocumentIterator(richEditControl1.Document, true);
    while (iterator.MoveNext())

How-to-use-the-Document-Iterator-and-Visitor-to-iterate-over-document-elements/CS/DocumentIteratorExample/MainWindow.xaml.cs#L32

MyVisitor visitor = new MyVisitor();
DocumentIterator iterator = new DocumentIterator(richEditControl1.Document, true);
while (iterator.MoveNext())

VB.NET

how-to-use-the-document-iterator-object-to-iterate-over-document-elements-t384347/VB/DocumentIteratorExample/Form1.vb#L24

Dim visitor As New MyVisitor()
Dim iterator As New DocumentIterator(richEditControl1.Document, True)
Do While iterator.MoveNext()

how-to-use-document-iterator-to-obtain-a-list-of-fonts-that-are-used-in-a-document-t438475/VB/Form1.vb#L25

Dim visitor As New MyVisitor()
Dim [iterator] As New DocumentIterator(richEditControl1.Document, True)
Do While [iterator].MoveNext()

how-to-emulate-the-ms-word-information-status-bar-when-using-richeditcontrol-t467150/VB/WindowsFormsApplication1/Form1.vb#L68

Private Function GetWordCount(ByVal richEdit As RichEditControl) As Integer
    Dim [iterator] As New DocumentIterator(richEdit.Document, True)
    Dim visitor As New StaticsticsVisitor()

how-to-use-documentiterator-to-export-a-rich-edit-document-in-a-custom-document-format-t632549/VB/DocumentIteratorExample/Form1.vb#L22

Private Sub Iterate(ByVal visitor As IDocumentVisitor)
    Dim iterator As New DocumentIterator(richEditControl1.Document, True)
    Do While iterator.MoveNext()

How-to-use-the-Document-Iterator-and-Visitor-to-iterate-over-document-elements/VB/DocumentIteratorExample/MainWindow.xaml.vb#L30

Dim visitor As New MyVisitor()
Dim iterator As New DocumentIterator(richEditControl1.Document, True)
Do While iterator.MoveNext()

Inheritance

Object

DocumentIterator