TextPointer.IsInSameDocument(TextPointer) メソッド

定義

名前空間:

System.Windows.Documents

アセンブリ:

PresentationFramework.dll

指定された位置が現在の位置と同じテキスト コンテナーに含まれているかどうかを示します。

public:
 bool IsInSameDocument(System::Windows::Documents::TextPointer ^ textPosition);

public bool IsInSameDocument (System.Windows.Documents.TextPointer textPosition);

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

Public Function IsInSameDocument (textPosition As TextPointer) As Boolean

パラメーター

textPosition

TextPointer

現在の位置と比較する位置を指定する TextPointer。

戻り値

Boolean

textPosition が示す位置が現在の位置と同じテキスト コンテナー内にある場合は true。それ以外の場合は false。

例外

ArgumentNullException

textPosition が nullです。

例

次の例では、このメソッドの使用方法を示します。 この例では、 メソッドをIsInSameDocument使用して、3 つの位置がすべて同じテキスト コンテナーに属する保証がない状況で、指定したが他の 2 つの指定されたTextPointerインスタンスの間に配置されているかどうかをTextPointer確認します。

// This method first checks for compatible text container scope, and then checks whether
// a specified position is between two other specified positions.
bool IsPositionContainedBetween(TextPointer positionToTest, TextPointer start, TextPointer end)
{
    // Note that without this check, an exception will be raised by CompareTo if positionToTest 
    // does not point to a position that is in the same text container used by start and end.
    //
    // This test also implicitely indicates whether start and end share a common text container.
    if (!positionToTest.IsInSameDocument(start) || !positionToTest.IsInSameDocument(end)) 
        return false;
    
    return start.CompareTo(positionToTest) <= 0 && positionToTest.CompareTo(end) <= 0;
}

' This method first checks for compatible text container scope, and then checks whether
' a specified position is between two other specified positions.
Private Function IsPositionContainedBetween(ByVal positionToTest As TextPointer, ByVal start As TextPointer, ByVal [end] As TextPointer) As Boolean
    ' Note that without this check, an exception will be raised by CompareTo if positionToTest 
    ' does not point to a position that is in the same text container used by start and end.
    '
    ' This test also implicitely indicates whether start and end share a common text container.
    If (Not positionToTest.IsInSameDocument(start)) OrElse (Not positionToTest.IsInSameDocument([end])) Then
        Return False
    End If

    Return start.CompareTo(positionToTest) <= 0 AndAlso positionToTest.CompareTo([end]) <= 0
End Function

注釈

複数 TextPointer のインスタンスを含むほとんどの操作は、問題のインスタンスが同じテキスト コンテナー スコープ内の位置を示している場合にのみ有効です。 たとえば、 CompareTo メソッドと GetOffsetToPosition メソッドは、現在の位置に関連付けられているテキスト コンテナーの外側の位置に 対して を指定して使用 TextPointer することはできません。 このメソッドを使用して、指定した TextPointer がそのような操作の現在の位置と互換性があることを確認します。