ReadOnlyParagraphCollection.Get(DocumentRange) Method

Gets all paragraphs located in the specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

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#

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Table.cs#L37

// Center the table header.
foreach (Paragraph p in document.Paragraphs.Get(tbl.FirstRow.Range))
{

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/TableActions.cs#L41

// Center the table header.
foreach (Paragraph p in document.Paragraphs.Get(tbl.FirstRow.Range))
{

VB.NET

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Table.vb#L35

' Center the table header.
For Each p As DevExpress.XtraRichEdit.API.Native.Paragraph In document.Paragraphs.[Get](tbl.FirstRow.Range)
    p.Alignment = DevExpress.XtraRichEdit.API.Native.ParagraphAlignment.Center

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/TableActions.vb#L36

' Center the table header.
For Each p As Paragraph In document.Paragraphs.Get(tbl.FirstRow.Range)
    p.Alignment = ParagraphAlignment.Center

word-document-api-examples/VB/CodeExamples/TablesActions.vb#L63

' Center the table header.
For Each p As DevExpress.XtraRichEdit.API.Native.Paragraph In document.Paragraphs.[Get](tbl.FirstRow.Range)
    p.Alignment = DevExpress.XtraRichEdit.API.Native.ParagraphAlignment.Center