ITextRangeProvider::GetEnclosingElement-Methode (uiautomationcore.h)

Gibt das innerste Element zurück, das den angegebenen Textbereich umschließt.

Syntax

HRESULT GetEnclosingElement(
  [out, retval] IRawElementProviderSimple **pRetVal
);

Parameter

[out, retval] pRetVal

Typ: IRawElementProviderSimple**

Der Benutzeroberflächenautomatisierung Anbieter des innersten Elements, das den angegebenen ITextRangeProvider umschließt.

Hinweis

Das einschließende Element kann mehr als nur den angegebenen ITextRangeProvider umfassen.

Wenn kein einschließendes Element gefunden wird, wird das übergeordnete ITextProvider-Element des ITextRangeProvider 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.

Bemerkungen

Beispiele

1. Dieses Beispiel zeigt einen Textstream, der einen Bildlink enthält. Der Link ist ein untergeordnetes Element des Bilds, aber beide umfassen denselben Textbereich und werden als eingebettete Objekte innerhalb des Textstreams verfügbar gemacht.

   Hello <Image Link> World

   • Bild und Link sind ebenfalls Nachfolger des ITextProvider des Streams, und beide können als childElement in einem Aufruf von ITextProvider::RangeFromChild angegeben werden.
   • Beim Aufrufen von ITextRangeProvider::RangeFromChild wird entweder das Bild oder der Link verwendet, derselbe Textbereich (Range1) zurückgibt.
   • GetChildren gibt den Link nicht zurück.
   • GetEnclosingElement gibt das Bild für keinen Textbereich zurück.
   • GetEnclosingElement für Range1 gibt den Link zurück.
   • GetChildren auf Range1 gibt keine untergeordneten Elemente zurück.
   • GetEnclosingElement für den Textbereich für den ITextProvider des Streams gibt den Anbieter zurück.
   • GetChildren im Textbereich für den ITextProvider des Streams gibt nur das Bild zurück.

2. Dieses Beispiel zeigt einen Textstream, der eine zweizellige Tabelle enthält, die von Text umgeben ist.

   Starttext

   Tabellenzelle 1

   Tabellenzelle 2

   Text beenden

   • Fall 1: Der ITextProvider des Streams und der gesamte Textbereich
     • ITextRangeProvider::GetEnclosingElement für den gesamten Textbereich gibt den ITextProvider des Streams zurück.
     • GetChildren gibt alle untergeordneten Elemente des ITextProvider des Streams zurück, in diesem Fall nur das table-Element.
   • Fall 2: Textbereich, der durch Aufrufen von ITextProvider::RangeFromChild für das Table-Element abgerufen wird:
     • ITextRangeProvider::GetEnclosingElement gibt das table-Element zurück.
     • ITextRangeProvider::GetChildren gibt beide Tabellenzellen zurück.
   • Fall 3: Textbereich, der den visuellen Inhalt von Tabellenzelle 1 Tabelle Zelle 2 umfasst:
     • ITextRangeProvider::GetEnclosingElement gibt das table-Element zurück.
     • ITextRangeProvider::GetChildren gibt beide Tabellenzellen zurück.
   • Fall 4: Textbereich, der das Wort Zelle der Tabellenzelle 1 umfasst:
     • ITextRangeProvider::GetEnclosingElement gibt das erste Zellelement zurück.
     • ITextRangeProvider::GetChildren gibt keine Elemente zurück.
   • Fall 5: Ein degenerierter (leerer) Textbereich, der beide Starts (Tabelle und erste Zelle) darstellt:
     • ITextRangeProvider::GetEnclosingElement gibt das erste Zellelement zurück (das innerste Element mit einem Bereich, der den entarteten Bereich enthält).
     • ITextRangeProvider::GetChildren gibt keine Elemente zurück.

Anforderungen

Anforderung	Wert
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)

Weitere Informationen

Übersicht über ITextProvider, ITextRangeProvider, ITextRangeProvider::GetChildren, Benutzeroberflächenautomatisierung Anbieter