This documentation is archived and is not being maintained.

TextRange.Contains Method

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

Namespace:  System.Windows.Documents
Assembly:  PresentationFramework (in PresentationFramework.dll)

public bool Contains(
	TextPointer textPointer
)

Parameters

textPointer
Type: System.Windows.Documents.TextPointer
A position to test for inclusion in the current selection.

Return Value

Type: System.Boolean
true if the specified position is located within the current selection; otherwise, false.

ExceptionCondition
ArgumentException

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

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

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;    
}


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: