ReadOnlyParagraphCollection.Get(DocumentRange) Method

Gets all paragraphs located in the specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

ReadOnlyParagraphCollection Get(
    DocumentRange range
)

VB.NET

Function Get(
    range As DocumentRange
) As ReadOnlyParagraphCollection

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange specifying the range in which to search for paragraphs.

Returns

Type	Description
ReadOnlyParagraphCollection	A ReadOnlyParagraphCollection object specifying the read-only collection of paragraphs.

Remarks

The Get method returns a collection of Paragraph objects contained in the specified range.

The method can be accessed using the RichEditControl.Document.Paragraphs.Get notation.

Note

If you operate with a selection range, the Get method should be enclosed within a DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair. Otherwise, an incorrect document model might be selected, resulting in an exception “Error: specified document position or range belongs to other document or subdocument” being thrown.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Get(DocumentRange) 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#

table-api-how-to-create-a-multiplication-table-in-code-e3231/CS/Table_API_Example/Form1.cs#L101

foreach (Paragraph p in doc.Paragraphs.Get(header_Row.Next.Range))
{

dxrichedit-for-wpf-table-api-how-to-create-a-multiplication-table-in-code-e3296/CS/MainWindow.xaml.cs#L23

_table.Style = doc.TableStyles["MyTableStyle"];
foreach (Paragraph p in doc.Paragraphs.Get(header_Row.Range)) {
    p.Style = doc.ParagraphStyles["MyTableHeaderStyle"];

how-to-apply-different-list-types-to-certain-paragraphs-dynamically-e3791/CS/Form1.cs#L80

ReadOnlyParagraphCollection paragraphs = document.Paragraphs.Get(document.Selection);

how-to-create-bulleted-list-in-code-e3402/CS/BulletedListExample/Form1.cs#L66

doc.BeginUpdate();
ReadOnlyParagraphCollection paragraphs = doc.Paragraphs.Get(doc.Selection);
foreach (Paragraph pgf in paragraphs)

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Export.cs#L109

options.AllowExtendingDocumentRange = false;
foreach (Paragraph par in document.Paragraphs.Get(item.ResultRange)) {
    plainText += document.GetText(par.Range, options);

VB.NET

table-api-how-to-create-a-multiplication-table-in-code-e3231/VB/Table_API_Example/Form1.vb#L94

For Each p As Paragraph In doc.Paragraphs.Get(header_Row.Next.Range)
    p.Style = doc.ParagraphStyles("MyTableCaptionStyle")

dxrichedit-for-wpf-table-api-how-to-create-a-multiplication-table-in-code-e3296/VB/MainWindow.xaml.vb#L25

_table.Style = doc.TableStyles("MyTableStyle")
For Each p As Paragraph In doc.Paragraphs.Get(header_Row.Range)
    p.Style = doc.ParagraphStyles("MyTableHeaderStyle")

how-to-apply-different-list-types-to-certain-paragraphs-dynamically-e3791/VB/Form1.vb#L76

Dim paragraphs As ReadOnlyParagraphCollection = document.Paragraphs.Get(document.Selection)

how-to-create-a-multilevel-numbered-list-in-code-e3404/VB/NumberedListExample/Form1.vb#L69

doc.BeginUpdate()
Dim paragraphs As ReadOnlyParagraphCollection = doc.Paragraphs.Get(doc.Selection)
For Each pgf As Paragraph In paragraphs

how-to-create-bulleted-list-in-code-e3402/VB/BulletedListExample/Form1.vb#L61

doc.BeginUpdate()
Dim paragraphs As ReadOnlyParagraphCollection = doc.Paragraphs.Get(doc.Selection)
For Each pgf As Paragraph In paragraphs