TextPointer.CompareTo(TextPointer) Método

Definición

Espacio de nombres:

System.Windows.Documents

Ensamblado:

PresentationFramework.dll

Realiza una comparación de ordinales entre las posiciones especificadas por el TextPointer actual y un segundo TextPointer especificado.

public:
 int CompareTo(System::Windows::Documents::TextPointer ^ position);

public int CompareTo (System.Windows.Documents.TextPointer position);

member this.CompareTo : System.Windows.Documents.TextPointer -> int

Public Function CompareTo (position As TextPointer) As Integer

Parámetros

position

TextPointer

TextPointer que especifica una posición para comparar a la posición actual.

Devoluciones

Int32

-1 si el TextPointer actual precede a position; 0 si las ubicaciones son las mismas; +1 si el TextPointer actual sigue a position.

Excepciones

ArgumentException

position especifica una posición fuera del contenedor de texto asociado a la posición actual.

Ejemplos

En el ejemplo siguiente se muestra un uso para este método. En el ejemplo, el CompareTo método se usa junto con el GetInsertionPosition método para probar si un especificado TextElement está vacío.

// Tests to see if the specified TextElement is empty (has no printatble content).
bool IsElementEmpty(TextElement element)
{
    // Find starting and ending insertion positions in the element.
    // Inward-facing directions are used to make sure that insertion position
    // will be found correctly in case when the element may contain inline 
    // formatting elements (such as a Span or Run that contains Bold or Italic elements).
    TextPointer start = element.ContentStart.GetInsertionPosition(LogicalDirection.Forward);
    TextPointer end = element.ContentEnd.GetInsertionPosition(LogicalDirection.Backward);
     
    // The element has no printable content if its first and last insertion positions are equal.
    return start.CompareTo(end) == 0;
} // End IsEmptyElement method.

' Tests to see if the specified TextElement is empty (has no printatble content).
Private Function IsElementEmpty(ByVal element As TextElement) As Boolean
    ' Find starting and ending insertion positions in the element.
    ' Inward-facing directions are used to make sure that insertion position
    ' will be found correctly in case when the element may contain inline 
    ' formatting elements (such as a Span or Run that contains Bold or Italic elements).
    Dim start As TextPointer = element.ContentStart.GetInsertionPosition(LogicalDirection.Forward)
    Dim [end] As TextPointer = element.ContentEnd.GetInsertionPosition(LogicalDirection.Backward)

    ' The element has no printable content if its first and last insertion positions are equal.
    Return start.CompareTo([end]) = 0

End Function ' End IsEmptyElement method.

Comentarios

Un valor de -1 indica que la posición especificada por el actual TextPointer precede a la posición especificada por position. Un valor de 0 indica que las posiciones indicadas son iguales. Un valor de +1 positivo indica que la posición especificada por el actual TextPointer sigue la posición especificada por position.

Consulte también

• IsInSameDocument(TextPointer)