TextRange.Contains(TextPointer) Method

Definition

Namespace:

System.Windows.Documents

Assembly:

PresentationFramework.dll

Checks whether a position (specified by a TextPointer) is located within the current selection.

public:
 bool Contains(System::Windows::Documents::TextPointer ^ textPointer);

public bool Contains (System.Windows.Documents.TextPointer textPointer);

member this.Contains : System.Windows.Documents.TextPointer -> bool

Public Function Contains (textPointer As TextPointer) As Boolean

Parameters

textPointer

TextPointer

A position to test for inclusion in the current selection.

Returns

Boolean

true if the specified position is located within the current selection; otherwise, false.

Exceptions

ArgumentException

Occurs when textPointer is not in the same document as the current selection.

Examples

The following example demonstrates the use of the Contains method.

// This method returns true if two specified selections overlap, including when the
// end of one selection serves as the beginning of the other.
bool DoSelectionsOverlap(TextRange selection1, TextRange selection2)
{
    // Is either end of selection2 contained by selection1?
    if (selection1.Contains(selection2.Start) || selection1.Contains(selection2.End))
    {
        // If so, the selections overlap.
        return true;
    }
    // If not, selection2 may still entirely contain selection1.
    // Is either end of selection1 contained by seleciotn2?
    else if (selection2.Contains(selection1.Start) || selection2.Contains(selection1.End))
    {
        // If so, the selections overlap.
        return true;
    }
    // If neither selection contains the begging or end of the other selection, 
    //the selections do not overlap.
    else
    {
        return false;
    }
}

' This method returns true if two specified selections overlap, including when the
' end of one selection serves as the beginning of the other.
Private Function DoSelectionsOverlap(ByVal selection1 As TextRange, ByVal selection2 As TextRange) As Boolean
    ' Is either end of selection2 contained by selection1?
    If selection1.Contains(selection2.Start) OrElse selection1.Contains(selection2.End) Then
        ' If so, the selections overlap.
        Return True
        ' If not, selection2 may still entirely contain selection1.
        ' Is either end of selection1 contained by seleciotn2?
    ElseIf selection2.Contains(selection1.Start) OrElse selection2.Contains(selection1.End) Then
        ' If so, the selections overlap.
        Return True
        ' If neither selection contains the begging or end of the other selection, 
        'the selections do not overlap.
    Else
        Return False
    End If
End Function

Remarks

Positions at either end of the current selection (indicated by Start and End) are considered to be part of the current selection.