Método ITextRangeProvider::ExpandToEnclosingUnit (uiautomationcore.h)

Artículo
03/08/2023

Normaliza el intervalo de texto por la unidad de texto especificada. El intervalo se expande si es menor que la unidad especificada o se acorta si es mayor que la unidad especificada.

Sintaxis

HRESULT ExpandToEnclosingUnit(
  [in] TextUnit unit
);

Parámetros

[in] unit

Tipo: TextUnit

Tipo de unidades de texto, como carácter, palabra, párrafo, etc.

Valor devuelto

Tipo: HRESULT

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Las aplicaciones cliente, como los lectores de pantalla, usan este método para recuperar la palabra, frase o párrafo completo que existe en el punto de inserción o la posición del símbolo de intercalación.

A pesar de su nombre, el método ITextRangeProvider::ExpandToEnclosingUnit no expande necesariamente un intervalo de texto. En su lugar, "normaliza" un intervalo de texto moviendo los puntos de conexión para que el intervalo abarque la unidad de texto especificada. El intervalo se expande si es menor que la unidad especificada o se acorta si es mayor que la unidad especificada. Si el intervalo ya es una cantidad exacta de las unidades especificadas, permanece sin cambios. Es fundamental que el método ExpandToEnclosingUnit normalice siempre los intervalos de texto de una manera coherente; de lo contrario, otros aspectos de la manipulación del intervalo de texto por unidad de texto serían impredecibles. En el diagrama siguiente se muestra cómo ExpandToEnclosingUnit normaliza un intervalo de texto moviendo los puntos de conexión del intervalo.

Diagrama en el que se muestran las posiciones del punto de conexión antes y después de una llamada a ExpandToEnclosingUnit

se establece de forma predeterminada en la siguiente unidad de texto más grande admitida si el control no admite la unidad de texto especificada. El orden, de la unidad más pequeña al más grande, es el siguiente:

Carácter
Formato
Word
Línea
Paragraph
Page
Documento

ExpandToEnclosingUnit respeta el texto visible y oculto.

Comportamiento del intervalo cuando la unidad es `TextUnit::Format`

TextUnit::Format como valor de unidad coloca el límite de un intervalo de texto para expandir o mover el intervalo en función de los atributos de texto compartidos (formato) del texto dentro del intervalo. Sin embargo, el uso de la unidad de texto de formato no debe mover ni expandir un intervalo de texto a través del límite de un objeto incrustado, como una imagen o un hipervínculo. Para obtener más información, consulta Unidades de texto de automatización de la interfaz de usuario o Patrones de control TextRange y TextRange.

Requisitos


Cliente mínimo compatible	Windows XP [aplicaciones de escritorio \| aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2003 [aplicaciones de escritorio \| aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	uiautomationcore.h (include UIAutomation.h)