DocumentRange.Contains(DocumentPosition) Method

Gets whether the current document range contains a specified position.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

bool Contains(
    DocumentPosition pos
)

VB.NET

Function Contains(
    pos As DocumentPosition
) As Boolean

Parameters

Name	Type	Description
pos	DocumentPosition	A DocumentPosition representing a position to test for inclusion.

Returns

Type	Description
Boolean	true if the specified position is contained within the range; otherwise, false.

Related GitHub Examples

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

dxrichedit-for-wpf-how-to-use-hit-testing-e2765/CS/DXRichEdit_HitTest/MainWindow.xaml.cs#L68

{
    if (bm.Range.Contains(pos))
    {

how-to-create-an-editor-similar-to-outlook-attachment-editor-e4911/CS/WindowsFormsApplication1/WindowsFormsApplication1/AttachmentsEditor.cs#L65

DocumentRange fieldRange = item.Value.DocField.ResultRange;
if (fieldRange.Contains(pos) && fieldRange.Start.ToInt() != pos.ToInt() && fieldRange.End.ToInt() != pos.ToInt())
{

how-to-navigate-through-bookmarks-in-code-e4891/CS/WindowsFormsApplication1/Form1.cs#L25

for(int i = 0; i < currentDoc.Bookmarks.Count; i++) {
    if(currentDoc.Bookmarks[i].Range.Contains(currentDoc.CaretPosition) || currentDoc.Bookmarks[i].Range.End.ToInt() == currentDoc.CaretPosition.ToInt()) {
        return i;

how-to-convert-static-urls-to-hyperlinks-e3448/CS/Form1.cs#L45

foreach (Hyperlink h in richEditControl1.Document.Hyperlinks) {
    if (documentRange.Contains(h.Range.Start))
        return true;

VB.NET

dxrichedit-for-wpf-how-to-use-hit-testing-e2765/VB/DXRichEdit_HitTest/MainWindow.xaml.vb#L59

For Each bm As Bookmark In bmCollection
    If bm.Range.Contains(pos) Then
        Dim bmHovered As Bookmark = bm

how-to-create-an-editor-similar-to-outlook-attachment-editor-e4911/VB/WindowsFormsApplication1/AttachmentsEditor.vb#L69

Dim fieldRange As DocumentRange = item.Value.DocField.ResultRange
If fieldRange.Contains(pos) AndAlso fieldRange.Start.ToInt() <> pos.ToInt() AndAlso fieldRange.End.ToInt() <> pos.ToInt() Then
    isLocked = True

how-to-navigate-through-bookmarks-in-code-e4891/VB/WindowsFormsApplication1/Form1.vb#L27

For i As Integer = 0 To currentDoc.Bookmarks.Count - 1
    If currentDoc.Bookmarks(i).Range.Contains(currentDoc.CaretPosition) OrElse currentDoc.Bookmarks(i).Range.End.ToInt() = currentDoc.CaretPosition.ToInt() Then
        Return i

how-to-convert-static-urls-to-hyperlinks-e3448/VB/Form1.vb#L48

For Each h As Hyperlink In richEditControl1.Document.Hyperlinks
    If documentRange.Contains(h.Range.Start) Then
        Return True