Método ITextProvider::GetVisibleRanges (uiautomationcore.h)

Artículo
03/08/2023

Recupera una matriz de intervalos de texto separados de un control basado en texto donde cada intervalo de texto representa un intervalo contiguo de texto visible.

Sintaxis

HRESULT GetVisibleRanges(
  [out, retval] SAFEARRAY **pRetVal
);

Parámetros

[out, retval] pRetVal

Tipo: SAFEARRAY**

Recibe la dirección de una matriz de punteros a las interfaces ITextRangeProvider de los intervalos de texto visibles o una matriz vacía. Nunca se devuelve una referencia NULL . Este parámetro se pasa sin inicializar.

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

Si el texto visible consta de un intervalo contiguo de texto, la matriz pRetVal debe contener un único intervalo de texto que represente todo el texto visible.

Si el texto visible consta de varios intervalos de texto separados, la matriz pRetVal debe contener un intervalo de texto para cada intervalo visible, empezando por el primer intervalo visible y finalizando con el último intervalo visible. Los intervalos separados de texto visible pueden producirse cuando el contenido de un control basado en texto está parcialmente oculto por una ventana superpuesta u otro objeto, o cuando un control basado en texto con varias páginas o columnas tiene contenido que se desplaza parcialmente fuera de la vista.

ITextProvider::GetVisibleRanges debe devolver un intervalo de texto degenerado (vacío) si no hay texto visible, si todo el texto se desplaza fuera de la vista o si el control basado en texto no contiene texto.

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 (incluir UIAutomation.h)