ITextProvider::GetVisibleRanges-Methode (uiautomationcore.h)

Artikel
08/26/2023

Ruft ein Array von zusammenhängenden Textbereichen aus einem textbasierten Steuerelement ab, in dem jeder Textbereich eine zusammenhängende Spanne sichtbaren Texts darstellt.

Syntax

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

Parameter

[out, retval] pRetVal

Typ: SAFEARRAY**

Empfängt die Adresse eines Arrays von Zeigern auf die ITextRangeProvider-Schnittstellen der sichtbaren Textbereiche oder eines leeren Arrays. Ein NULL-Verweis wird nie zurückgegeben. Dieser Parameter wird nicht initialisiert übergeben.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Wenn der sichtbare Text aus einer zusammenhängenden Textspanne besteht, sollte das pRetVal-Array einen einzelnen Textbereich enthalten, der den gesamten sichtbaren Text darstellt.

Wenn der sichtbare Text aus mehreren, nicht zusammenhängenden Textspannen besteht, sollte das pRetVal-Array einen Textbereich für jede sichtbare Spanne enthalten, beginnend mit der ersten sichtbaren Spanne und endend mit der letzten sichtbaren Spanne. Disjoint-Spannen von sichtbarem Text können auftreten, wenn der Inhalt eines textbasierten Steuerelements teilweise durch ein überlappende Fenster oder ein anderes Objekt verdeckt wird oder wenn ein textbasiertes Steuerelement mit mehreren Seiten oder Spalten Inhalte enthält, die teilweise aus der Ansicht heraus scrollen.

ITextProvider::GetVisibleRanges sollte einen entarteten (leeren) Textbereich zurückgeben, wenn kein Text sichtbar ist, wenn der gesamte Text aus der Ansicht gescrollt wird oder wenn das textbasierte Steuerelement keinen Text enthält.

Anforderungen


Unterstützte Mindestversion (Client)	Windows XP [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	uiautomationcore.h (uiAutomation.h einschließen)