uiautomationcoreapi.h-Header

Dieser Header wird von Windows-Barrierefreiheitsfeatures verwendet. Weitere Informationen finden Sie unter

• Windows-Barrierefreiheitsfeatures

uiautomationcoreapi.h enthält die folgenden Programmierschnittstellen:

Functions

DockPattern_SetDockPosition Dockt das UI Automation-Element an der angeforderten dockPosition in einem Andockcontainer an.
ExpandCollapsePattern_Collapse Blendet alle untergeordneten Knoten, Steuerelemente oder Inhalte des UI Automation-Elements aus.
ExpandCollapsePattern_Expand Erweitert ein Steuerelement auf dem Bildschirm, sodass weitere Informationen angezeigt werden.
GridPattern_GetItem Ruft den Knoten für ein Element in einem Raster ab.
InvokePattern_Invoke Sendet eine Anforderung zum Aktivieren eines Steuerelements und Initiieren der einzelnen eindeutigen Aktion. (InvokePattern_Invoke)
ItemContainerPattern_FindItemByProperty Ruft einen Knoten innerhalb eines enthaltenden Knotens basierend auf einem angegebenen Eigenschaftswert ab.
LegacyIAccessiblePattern_DoDefaultAction Führt die Microsoft Active Accessibility-Standardaktion für das -Element aus. (LegacyIAccessiblePattern_DoDefaultAction)
LegacyIAccessiblePattern_GetIAccessible Ruft ein IAccessible-Objekt ab, das dem Ui Automation-Element entspricht.
LegacyIAccessiblePattern_Select Führt eine Microsoft Active Accessibility-Auswahl aus. (LegacyIAccessiblePattern_Select)
LegacyIAccessiblePattern_SetValue Legt die Microsoft Active Accessibility Value-Eigenschaft für den Knoten fest.
MultipleViewPattern_GetViewName Ruft den Namen einer steuerelementspezifischen Ansicht ab. (MultipleViewPattern_GetViewName)
MultipleViewPattern_SetCurrentView Legt ein Steuerelement auf ein anderes Layout fest.
RangeValuePattern_SetValue Legt den Wert eines Steuerelements fest, das über einen numerischen Bereich verfügt.
ScrollItemPattern_ScrollIntoView Scrollt im Inhaltsbereich eines Containerobjekts, um das UI Automation-Element innerhalb der sichtbaren Region (Viewport) des Containers anzuzeigen.
ScrollPattern_Scroll Scrollt den aktuell sichtbaren Bereich des Inhaltsbereichs mit dem angegebenen ScrollAmount, horizontal, vertikal oder beides.
ScrollPattern_SetScrollPercent Scrollt einen Container horizontal, vertikal oder beides zu einer bestimmten Position.
SelectionItemPattern_AddToSelection Fügt einer Auswahl in einem Steuerelement ein nicht ausgewähltes Element hinzu.
SelectionItemPattern_RemoveFromSelection Entfernt ein Element aus der Auswahl in einem Auswahlcontainer.
SelectionItemPattern_Select Wählt ein Element in einem Auswahlcontainer aus.
SynchronizedInputPattern_Cancel Bewirkt, dass der Benutzeroberflächenautomatisierungsanbieter nicht mehr auf Maus- oder Tastatureingaben lauscht.
SynchronizedInputPattern_StartListening Bewirkt, dass der Benutzeroberflächenautomatisierungsanbieter mit der Überwachung der Maus- oder Tastatureingabe beginnt.
TextPattern_get_DocumentRange Ruft den Textbereich für das gesamte Dokument ab.
TextPattern_get_SupportedTextSelection Bestimmt, ob der Inhalt des Textcontainers ausgewählt und deaktiviert werden kann.
TextPattern_GetSelection Ruft den aktuellen Bereich des ausgewählten Texts aus einem Textcontainer ab, der das Textmuster unterstützt.
TextPattern_GetVisibleRanges Ruft ein Array von nicht zusammenhängenden Textbereichen aus einem Textcontainer ab, wobei jeder Textbereich mit der ersten teilweise sichtbaren Zeile beginnt und mit dem Ende der letzten teilweise sichtbaren Zeile endet.
TextPattern_RangeFromChild Ruft den Textbereich ab, den ein bestimmter Knoten umfasst.
TextPattern_RangeFromPoint Ruft den entarteten (leeren) Textbereich ab, der den angegebenen Bildschirmkoordinaten am nächsten ist. (TextPattern_RangeFromPoint)
TextRange_AddToSelection Fügt der vorhandenen Auflistung hervorgehobenen Texts in einem Textcontainer hinzu, der mehrere, nicht zusammenhängende Auswahlen unterstützt, indem zusätzlichen Text hervorgehoben wird, der den aufrufenden Textbereichs-Endpunkten Start und Ende entspricht.
TextRange_Clone Kopiert einen Textbereich.
TextRange_Compare Vergleicht zwei Textbereiche.
TextRange_CompareEndpoints Gibt einen Wert zurück, der angibt, ob zwei Textbereiche identische Endpunkte aufweisen.
TextRange_ExpandToEnclosingUnit Erweitert den Textbereich auf eine größere oder kleinere Einheit, z. B. Zeichen, Word, Zeile oder Seite.
TextRange_FindAttribute Sucht in einer angegebenen Richtung nach dem ersten Textteil, der ein angegebenes Textattribute unterstützt.
TextRange_FindText Gibt den ersten Textbereich in der angegebenen Richtung zurück, der den vom Client gesuchten Text enthält.
TextRange_GetAttributeValue Ruft den Wert eines Textattributes für einen Textbereich ab.
TextRange_GetBoundingRectangles Ruft die mindeste Anzahl von umgebenden Rechtecken ab, die den Bereich einschließen können, nämlich ein Rechteck pro Zeile.
TextRange_GetChildren Gibt alle Elemente der Benutzeroberflächenautomatisierung zurück, die im angegebenen Textbereich enthalten sind.
TextRange_GetEnclosingElement Gibt den Knoten für den nächstkleinsten Anbieter zurück, der den Bereich abdeckt.
TextRange_GetText Gibt den Text in einem Textbereich bis zu einer angegebenen Anzahl von Zeichen zurück.
TextRange_Move Verschiebt den Textbereich um die angegebene Anzahl von Einheiten, die vom Client angefordert werden.
TextRange_MoveEndpointByRange Verschiebt einen Endpunkt eines Bereichs in den Endpunkt eines anderen Bereichs.
TextRange_MoveEndpointByUnit Verschiebt einen Endpunkt des Bereichs um die angegebene Anzahl von Einheiten.
TextRange_RemoveFromSelection Entfernt den ausgewählten Text, der dem aufrufenden Textbereich TextPatternRangeEndpoint_Start und TextPatternRangeEndpoint_End Endpunkten entspricht, aus einer vorhandenen Auflistung ausgewählter Texte in einem Textcontainer, der mehrere, unzusammenige Auswahlen unterstützt.
TextRange_ScrollIntoView Scrollt den Text, sodass der angegebene Bereich im Viewport sichtbar ist.
TextRange_Select Markiert einen Textbereich.
TogglePattern_Toggle Schaltet ein Steuerelement in den nächsten unterstützten Zustand um.
TransformPattern_Move Verschiebt ein Element an eine angegebene Position auf dem Bildschirm.
TransformPattern_Resize Ändert die Größe eines Elements auf dem Bildschirm.
TransformPattern_Rotate Dreht ein Element auf dem Bildschirm.
UiaAddEvent Fügt einen Listener für Ereignisse auf einem Knoten in der Benutzeroberflächenautomatisierungsstruktur hinzu.
UiaClientsAreListening Ruft einen Wert ab, der angibt, ob eine Clientanwendung Microsoft UI Automation-Ereignisse abonniert hat.
UiaDisconnectAllProviders Gibt alle Microsoft-Benutzeroberflächenautomatisierungsressourcen frei, die von allen Anbietern verwaltet werden, die dem Aufrufprozess zugeordnet sind.
UiaDisconnectProvider Gibt alle Verweise frei, die ein bestimmter Anbieter für Microsoft-Benutzeroberflächenautomatisierungsobjekte enthält.
UiaEventAddWindow Fügt dem Ereignislistener ein Fenster hinzu.
UiaEventRemoveWindow Entfernt ein Fenster aus dem Ereignislistener.
UiaFind Ruft einen oder mehrere Benutzeroberflächenautomatisierungsknoten ab, die den Suchkriterien entsprechen.
UiaGetErrorDescription Ruft eine Fehlerzeichenfolge ab, damit sie an den Client übergeben werden kann. Diese Methode wird von Clients nicht direkt verwendet.
UiaGetPatternProvider Ruft ein Steuerelementmuster ab.
UiaGetPropertyValue Ruft den Wert einer Ui Automation-Eigenschaft ab.
UiaGetReservedMixedAttributeValue Ruft einen reservierten Wert ab, der angibt, dass der Wert eines Microsoft UI Automation-Textattributes innerhalb eines Textbereichs variiert.
UiaGetReservedNotSupportedValue Ruft einen reservierten Wert ab, der angibt, dass eine Microsoft UI Automation-Eigenschaft oder ein Text-Attribut nicht unterstützt wird.
UiaGetRootNode Ruft den Stammknoten der Benutzeroberflächenautomatisierung ab.
UiaGetRuntimeId Ruft den Laufzeitbezeichner eines Benutzeroberflächenautomatisierungsknotens ab.
UiaGetUpdatedCache Updates den Cache von Eigenschaftswerten und Steuerelementmustern.
UiaHasServerSideProvider Ermittelt, ob ein Fenster über eine Microsoft-Benutzeroberflächenautomatisierungsimplementierung verfügt.
UiaHostProviderFromHwnd Ruft den Hostanbieter für ein Fenster ab.
UiaHPatternObjectFromVariant Ruft ein Steuerelementmusterobjekt aus einem VARIANT-Typ ab.
UiaHTextRangeFromVariant Ruft einen Textbereich aus einem VARIANT-Typ ab.
UiaHUiaNodeFromVariant Ruft einen HUIANODE aus einem VARIANT-Typ ab.
UiaIAccessibleFromProvider Ruft eine IAccessible-Implementierung ab, die Microsoft Active Accessibility-Daten im Auftrag eines Microsoft-Anbieters für die Benutzeroberflächenautomatisierung bereitstellt.
UiaLookupId Ruft den ganzzahligen Bezeichner ab, der in Methoden verwendet werden kann, die eine PROPERTYID, PATTERNID, CONTROLTYPEID, TEXTATTRIBUTEID oder EVENTID erfordern.
UiaNavigate Navigiert in der Benutzeroberflächenautomatisierungsstruktur und ruft optional zwischengespeicherte Informationen ab.
UiaNodeFromFocus Ruft den Benutzeroberflächenautomatisierungsknoten für das Benutzeroberflächenelement ab, das derzeit den Eingabefokus hat.
UiaNodeFromHandle Ruft den Benutzeroberflächenautomatisierungsknoten ab, der einem Fenster zugeordnet ist.
UiaNodeFromPoint Ruft den Benutzeroberflächenautomatisierungsknoten für das Element am angegebenen Punkt ab.
UiaNodeFromProvider Ruft den Benutzeroberflächenautomatisierungsknoten für einen Rohelementanbieter ab.
UiaNodeRelease Löscht einen Knoten aus dem Arbeitsspeicher.
UiaPatternRelease Löscht ein zugeordnetes Musterobjekt aus dem Arbeitsspeicher.
UiaProviderForNonClient Ruft den Anbieter für den gesamten Nichtclientbereich eines Fensters oder für ein Steuerelement im Nichtclientbereich eines Fensters ab.
UiaProviderFromIAccessible Erstellt einen Microsoft-Benutzeroberflächenautomatisierungsanbieter basierend auf dem angegebenen Microsoft Active Accessibility-Objekt.
UiaRaiseActiveTextPositionChangedEvent Wird von einem Anbieter aufgerufen, um den Microsoft-Benutzeroberflächenautomatisierungskern zu benachrichtigen, dass ein Textsteuerelement Text programmgesteuert geändert hat. (UiaRaiseActiveTextPositionChangedEvent)
UiaRaiseAsyncContentLoadedEvent Wird von einem Anbieter aufgerufen, um den Microsoft-Benutzeroberflächenautomatisierungskern zu benachrichtigen, dass Inhalte asynchron geladen werden.
UiaRaiseAutomationEvent Benachrichtigt Die Listener über ein Ereignis.
UiaRaiseAutomationPropertyChangedEvent Wird von Anbietern aufgerufen, um den Microsoft-Benutzeroberflächenautomatisierungskern zu benachrichtigen, dass eine Elementeigenschaft geändert wurde.
UiaRaiseChangesEvent Wird von Anbietern aufgerufen, um den Microsoft-Benutzeroberflächenautomatisierungskern zu benachrichtigen, dass eine Änderung erfolgt ist.
UiaRaiseNotificationEvent Wird von Anbietern aufgerufen, um ein Benachrichtigungsereignis zu initiieren.
UiaRaiseStructureChangedEvent Wird von einem Anbieter aufgerufen, um den Microsoft-Benutzeroberflächenautomatisierungskern zu benachrichtigen, dass sich die Struktur geändert hat.
UiaRaiseTextEditTextChangedEvent Wird von einem Anbieter aufgerufen, um den Microsoft-Benutzeroberflächenautomatisierungskern zu benachrichtigen, dass ein Textsteuerelement Text programmgesteuert geändert hat. (UiaRaiseTextEditTextChangedEvent)
UiaRectIsEmpty Ruft einen booleschen Wert ab, der angibt, ob für ein Rechteck alle Koordinaten auf 0 festgelegt sind.
UiaRectSetEmpty Legt die Elemente einer UiaRect-Struktur auf 0 fest.
UiaRegisterProviderCallback Registriert die anwendungsdefinierte Methode, die von der Benutzeroberflächenautomatisierung aufgerufen wird, um einen Anbieter für ein Element abzurufen.
UiaRemoveEvent Entfernt einen Listener für Ereignisse auf einem Knoten in der Benutzeroberflächenautomatisierungsstruktur.
UiaReturnRawElementProvider Ruft eine Schnittstelle für den Benutzeroberflächenautomatisierungsanbieter für ein Fenster ab.
UiaSetFocus Legt den Eingabefokus auf das angegebene Element auf der Benutzeroberfläche fest.
UiaTextRangeRelease Löscht ein zugeordnetes Textbereichsobjekt aus dem Arbeitsspeicher.
ValuePattern_SetValue Legt den Textwert eines Elements fest.
VirtualizedItemPattern_Realize Ermöglicht den vollständigen Zugriff auf das virtuelle Element als Benutzeroberflächen-Automatisierungselement. (VirtualizedItemPattern_Realize)
WindowPattern_Close Schließt ein geöffnetes Fenster.
WindowPattern_SetWindowVisualState Legt den visuellen Zustand eines Fensters fest. Beispielsweise, um ein Fenster zu maximieren.
WindowPattern_WaitForInputIdle Bewirkt, dass der aufrufende Code für die angegebene Zeitspanne oder solange blockiert wird, bis der zugeordnete Prozess in den Leerlauf wechselt, je nachdem, was zuerst zutrifft. (WindowPattern_WaitForInputIdle)

Rückruffunktionen

UiaEventCallback Eine vom Client implementierte Funktion, die von der Benutzeroberflächenautomatisierung aufgerufen wird, wenn ein Ereignis ausgelöst wird, das der Client abonniert hat.
UiaProviderCallback Eine anwendungsdefinierte Funktion, die von der Benutzeroberflächenautomatisierung aufgerufen wird, um einen clientseitigen Anbieter für ein Element abzurufen.

Strukturen

UiaAndOrCondition Hinweis Diese Struktur ist veraltet.  Enthält Informationen zu einer komplexen Bedingung.
UiaAsyncContentLoadedEventArgs Hinweis Diese Struktur ist veraltet.  Enthält Informationen zu einem Ereignis, das ausgelöst wird, wenn Inhalte asynchron von einem UI-Element geladen werden.
UiaCacheRequest Hinweis Diese Struktur ist veraltet.  Enthält Informationen zu einer Anforderung zum Zwischenspeichern von Daten zu UI Automation-Elementen.
UiaCondition Hinweis Diese Struktur ist veraltet.  Enthält Informationen zu einer Bedingung.
UiaEventArgs Hinweis Diese Struktur ist veraltet.  Enthält Informationen zu einem Microsoft UI Automation-Ereignis.
UiaFindParams Hinweis Diese Struktur ist veraltet.  Enthält Parameter, die in der UiaFind-Funktion verwendet werden.
UiaNotCondition Hinweis Diese Struktur ist veraltet.  Enthält Informationen zu einer negativen Bedingung.
UiaPropertyChangedEventArgs Hinweis Diese Struktur ist veraltet.  Enthält Informationen zu einem Ereignis, das ausgelöst wird, wenn eine Änderung der Eigenschaft eines Microsoft UI Automation-Elements auftritt.
UiaPropertyCondition Hinweis Diese Struktur ist veraltet.  Enthält Informationen zu einer Bedingung, die verwendet wird, um Benutzeroberflächenautomatisierungselemente mit einer übereinstimmenden Eigenschaft zu finden.
UiaStructureChangedEventArgs Hinweis Diese Struktur ist veraltet.  Enthält Informationen zu einem Ereignis, das ausgelöst wird, wenn sich die Struktur der Microsoft UI Automation-Struktur ändert.
UiaWindowClosedEventArgs Hinweis Diese Struktur ist veraltet.  Enthält Informationen zu einem Ereignis, das ausgelöst wird, wenn mindestens ein Fenster geschlossen wird.

Enumerationen

AsyncContentLoadedState Enthält Werte, die den Fortschritt des asynchronen Ladens von Inhalten beschreiben.
AutomationElementMode Die AutomationElementMode -Enumeration (uiautomationcoreapi.h) enthält Werte, die den Typ des Verweises angeben, der beim Zurückgeben von UI Automation-Elementen verwendet werden soll.
AutomationIdentifierType Enthält Werte, die in der Funktion UiaLookupId verwendet werden.
ConditionType Enthält Werte, die einen Typ von UiaCondition angeben.
EventArgsType Enthält Werte, die den von einer UiaEventArgs-Struktur beschriebenen Ereignistyp angeben.
NormalizeState Enthält Werte, die das Verhalten von UiaGetUpdatedCache angeben.
Propertyconditionflags Die PropertyConditionFlags-Enumeration (uiautomationcoreapi.h) enthält Werte, die beim Erstellen von Eigenschaftenbedingungen verwendet werden.
ProviderType Enthält Werte, die den Typ eines clientseitigen (Proxy)-Ui Automation-Anbieters angeben.
Treescope Die TreeScope-Enumeration (uiautomationcoreapi.h) enthält Werte, die den Bereich verschiedener Vorgänge in der Microsoft UI Automation-Struktur angeben.
TreeTraversalOptions Die TreeTraversalOptions -Enumeration (uiautomationcoreapi.h) definiert Werte, die zum Anpassen der Strukturnavigationsreihenfolge verwendet werden können.