SubDocument.CreateRange(DocumentPosition, Int32) Method

Creates a new document range using the specified start position and range length.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

DocumentRange CreateRange(
    DocumentPosition start,
    int length
)

VB.NET

Function CreateRange(
    start As DocumentPosition,
    length As Integer
) As DocumentRange

Parameters

Name	Type	Description
start	DocumentPosition	A DocumentPosition object specifying the start position.
length	Int32	An integer value specifying the range length.

Returns

Type	Description
DocumentRange	A DocumentRange object.

Exceptions

Type	Description
ArgumentException	Throws if the negative value is passed as the start parameter.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CreateRange(DocumentPosition, Int32) 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/Range.cs#L14

DocumentPosition myStart = document.CreatePosition(69);
DocumentRange myRange = document.CreateRange(myStart, 216);
document.Selection = myRange;

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/RangeActions.cs#L14

DocumentPosition myStart = document.CreatePosition(69);
DocumentRange myRange = document.CreateRange(myStart, 216);
document.Selection = myRange;

winforms-reporting-xrrichtext-insert-a-page-break-from-rtf-contents/CS/WindowsFormsApplication1/Form1.cs#L27

foreach(DocumentRange dr in ranges) {
    DocumentRange tmpRange = server.Document.CreateRange(dp, dr.Start.ToInt() - dp.ToInt());
    collection.Add(new MyRtfObject() { RtfSplitContent = server.Document.GetRtfText(tmpRange) });

winforms-richeditcontrol-common-api/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L336

string currentToolTipText = String.Format("Position: {0}, Character: {1}", pos.ToString(),
    richEdit.Document.GetText(richEdit.Document.CreateRange(pos, 1)));

winforms-richedit-layout-api-practical-usage/CS/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.cs#L14

ReadOnlyShapeCollection shapes = subDocument.Shapes.Get(subDocument.CreateRange(docPosition, 1));
ReadOnlyDocumentImageCollection images = subDocument.Images.Get(subDocument.CreateRange(docPosition, 1));

VB.NET

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Range.vb#L13

Dim myStart As DevExpress.XtraRichEdit.API.Native.DocumentPosition = document.CreatePosition(69)
Dim myRange As DevExpress.XtraRichEdit.API.Native.DocumentRange = document.CreateRange(myStart, 216)
document.Selection = myRange

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/RangeActions.vb#L11

Dim myStart As DocumentPosition = document.CreatePosition(69)
Dim myRange As DocumentRange = document.CreateRange(myStart, 216)
document.Selection = myRange

winforms-reporting-xrrichtext-insert-a-page-break-from-rtf-contents/VB/WindowsFormsApplication1/Form1.vb#L26

For Each dr As DocumentRange In ranges
    Dim tmpRange As DocumentRange = server.Document.CreateRange(dp, dr.Start.ToInt() - dp.ToInt())
    collection.Add(New MyRtfObject() With {.RtfSplitContent = server.Document.GetRtfText(tmpRange)})

winforms-richeditcontrol-common-api/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L345

Dim currentToolTipText As String = String.Format("Position: {0}, Character: {1}", pos.ToString(),
                                                 richEdit.Document.GetText(richEdit.Document.CreateRange(pos, 1)))

winforms-richedit-layout-api-practical-usage/VB/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.vb#L17

Dim shapes As ReadOnlyShapeCollection = subDocument.Shapes.Get(subDocument.CreateRange(docPosition, 1))
Dim images As ReadOnlyDocumentImageCollection = subDocument.Images.Get(subDocument.CreateRange(docPosition, 1))