TextPointer.IsInSameDocument(TextPointer) Метод

Определение

Определение, находится ли указанное положение в том же текстовом контейнере, что и текущее положение.Indicates whether the specified position is in the same text container as the current position.

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, который указывает положение для сравнения с текущим положением.A TextPointer that specifies a position to compare to the current position.

Возвраты

true, если textPosition указывает положение, которое располагается в том же текстовом контейнере, что и текущее положение; в противном случае — false.true if textPosition indicates a position that is in the same text container as the current position; otherwise, false.

Исключения

Свойство textPosition имеет значение null.textPosition is null.

Примеры

В следующем примере демонстрируется использование этого метода.The following example demonstrates a use for this method. В примере IsInSameDocument метод используется для проверки того, находится ли TextPointer заданный объект между двумя другими заданными TextPointer экземплярами в ситуации, когда нет гарантии, что все три позиции принадлежат одному и тому же текстовому контейнеру.The example uses the IsInSameDocument method to check whether a specified TextPointer is positioned between two other specified TextPointer instances in a situation when there is no guarantee that all three positions belong to the same text container.

// 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 несколько экземпляров, допустимы только в том случае, если искомые экземпляры указывают позиции, которые находятся в одной области текстового контейнера.Most operations that involve multiple TextPointer instances are only valid if the instances in question indicate positions that are in the same text container scope. Например, CompareTo методы и GetOffsetToPosition не могут использоваться с a TextPointer в качестве места вне контейнера текста, связанного с текущей позицией.For example the CompareTo and GetOffsetToPosition methods cannot be used with a TextPointer to a position outside of the text container associated with the current position. Используйте этот метод, чтобы убедиться, что TextPointer указанный объект совместим с текущей позицией для таких операций.Use this method to verify that a specified TextPointer is compatible with the current position for such operations.

Применяется к