AutomationProperties Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Bietet Unterstützung zum Abrufen oder Festlegen instance Werte von Automatisierungseigenschaften. Diese Eigenschaftswerte werden als angefügte Eigenschaften (in der Regel in XAML) festgelegt und ergänzen oder überschreiben Automatisierungseigenschaftenwerte aus dem AutomationPeer eines Steuerelements.
public ref class AutomationProperties sealed/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class AutomationProperties final[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AutomationPropertiesPublic NotInheritable Class AutomationProperties- Vererbung
- Attribute
Windows-Anforderungen
| Gerätefamilie |
Windows 10 (eingeführt in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (eingeführt in v1.0)
|
Beispiele
Tipp
Öffnen Sie die WinUI 3-Katalog-App, und sehen Sie sich die folgenden Barrierefreiheitsprinzipien in Aktion an:
Die WinUI 3-Katalog-App enthält interaktive Beispiele für die meisten WinUI 3-Steuerelemente, -Features und -Funktionen. Abrufen der App aus dem Microsoft Store oder Abrufen des Quellcodes auf GitHub
Hinweise
AutomationProperties ist die Hostdienstklasse für mehrere angefügte XAML-Eigenschaften. Der Zweck dieser angefügten Eigenschaften besteht darin, das Festlegen verschiedener werte pro instance zu ermöglichen, die für die Meldung eines UI-Elements an das Microsoft Benutzeroberflächenautomatisierung Accessibility Framework relevant sind. Dies ist nützlich in Fällen, in denen der Klassenentwurf des UI-Elements nicht bereits andere UI-bezogene Eigenschaftswerte im Rahmen des Microsoft-Benutzeroberflächenautomatisierung-Integrations- oder Peerimplementierungsverhaltens weiterleitet oder der weitergeleitete Wert nicht der Wert ist, den Sie Microsoft Benutzeroberflächenautomatisierung melden möchten.
Um den XAML-Prozessorzugriff auf die angefügten Eigenschaften zu unterstützen und auch gleichwertige Get- und Set-Vorgänge für Code verfügbar zu machen, verfügt jede angefügte XAML-Eigenschaft über ein Paar von Get - und Set-Accessormethoden , die ebenfalls Mitglieder von AutomationProperties sind. Beispielsweise unterstützen und bieten die Methoden GetName und SetName die entsprechende Code-only-Unterstützung für das Melden von Automatisierungsnamenwerten an Microsoft Benutzeroberflächenautomatisierung, anstatt die angefügte Name-Eigenschaft zu verwenden, um sie in XAML festzulegen. Alternativ können Sie das Abhängigkeitseigenschaftensystem verwenden, um den Wert der angefügten Eigenschaft abzurufen oder festzulegen. Dadurch wird auch der zugrunde liegende Wert an Microsoft Benutzeroberflächenautomatisierung gemeldet. Rufen Sie GetValue oder SetValue auf, und übergeben Sie die Argumente des festzulegenden Abhängigkeitseigenschaftsbezeichners und einen Verweis auf das Zielobjekt, für das der Wert abgerufen oder festgelegt werden soll.
Name-Eigenschaft
Von den verschiedenen angefügten Eigenschaften ist wahrscheinlich die wichtigste Eigenschaft Name. Dies liegt daran, dass es die Name-Eigenschaft ist, auf die am häufigsten zugegriffen und von Hilfstechnologien gemeldet wird, wenn Benutzer in einem Barrierefreiheitsszenario mit einer App interagieren. Der Name dient als lesbarer Bezeichner für das Benutzeroberflächenelement.
Verschiedene UI-Elemente verfügen über Peerweiterleitung, die basierend auf anderen Elementeigenschaften einen Standardname-Wert bereitstellen kann. Beispielsweise leitet die Peerweiterleitung für die Button-Klasse die ToString-Auswertung des Button-Inhalts weiter und verwendet diese Zeichenfolge als Standardnamen. Um diese Standardeinstellung zu überschreiben oder auf andere Weise einen Name-Wert für alle Benutzeroberflächenelemente anzugeben, in denen kein Microsoft Benutzeroberflächenautomatisierung Name verfügbar ist, legen Sie die angefügte Name-Eigenschaft für dieses Element in XAML fest. Weitere Informationen dazu, warum ein Microsoft Benutzeroberflächenautomatisierung Name wichtig ist, finden Sie unter Grundlegende Informationen zur Barrierefreiheit. Weitere Informationen zum Testen, ob ein Element bereits über einen vom Peer bereitgestellten Namen verfügt, der nützlich ist, finden Sie unter Barrierefreiheitstests.
Aus Lokalisierungsgründen sollten Sie hartcodierte Zeichenfolgenwerte für den Namen in XAML vermeiden. Wenn Sie die x:Uid-Direktive für das Element festlegen, können Sie RESW-Ressourcen verwenden, um die Eigenschaft als Ziel festzulegen und unterschiedliche Werte für die Lokalisierung bereitzustellen. Für angefügte Eigenschaften erfordert das Formular "Ressourcenbezeichner" eine vollständige Qualifizierung der angefügten Eigenschaft im XAML-Format, einschließlich ihres Namespaces und eines using:-Präfixes. Wenn Sie z. B. den wert der AutomationProperties.Name angefügten Eigenschaft auf eine Ressource ausrichten möchten, die den x:Uid-Direktivewert "sendButton" aufweist, lautet der Namewert des Datenelements in den RESW-Ressourcen. sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name
Eine vollständige Liste finden Sie unter Angefügte Eigenschaften (weitere Informationen zu jeder angefügten Eigenschaft finden Sie im Bezeichnerfeld jeder Eigenschaft).
Versionsverlauf
| Windows-Version | SDK-Version | Mehrwert |
|---|---|---|
| 1511 | 10586 | GetLandmarkType |
| 1511 | 10586 | GetLocalizedLandmarkType |
| 1511 | 10586 | SetLandmarkType |
| 1511 | 10586 | SetLocalizedLandmarkType |
| 1607 | 14393 | GetDescribedBy |
| 1607 | 14393 | GetFlowsFrom |
| 1607 | 14393 | GetFlowsTo |
| 1607 | 14393 | GetFullDescription |
| 1607 | 14393 | GetIsDataValidForForm |
| 1607 | 14393 | GetIsPeripheral |
| 1607 | 14393 | GetLocalizedControlType |
| 1607 | 14393 | SetFullDescription |
| 1607 | 14393 | SetIsDataValidForForm |
| 1607 | 14393 | SetIsPeripheral |
| 1607 | 14393 | SetLocalizedControlType |
| 1703 | 15063 | GetCulture |
| 1703 | 15063 | Setculture |
| 1803 | 17134 | GetHeadingLevel |
| 1803 | 17134 | SetHeadingLevel |
| 1809 | 17763 | GetIsDialog |
| 1809 | 17763 | SetIsDialog |
Eigenschaften
Angefügte Eigenschaften
| AcceleratorKey |
Ruft eine Zeichenfolge ab, die die Tastenkombinationen (auch Tastenkombinationen genannt) für das Automation-Element enthält, oder legt diese fest. |
| AccessibilityView |
Ruft den Microsoft Benutzeroberflächenautomatisierung-Strukturansichtsmodus für ein Element ab oder legt diese fest. |
| AccessKey |
Ruft eine Zeichenfolge ab, die das Zugriffstastenzeichen für das Automation-Element enthält, oder legt diese fest. |
| Annotations |
Ruft eine Liste von Anmerkungsobjekten in einem Dokument ab, z. B. Kommentar, Kopfzeile, Fußzeile usw. |
| AutomationControlType |
Ruft den Steuerelementtyp für Microsoft Benutzeroberflächenautomatisierung ab oder legt diese fest. |
| AutomationId |
Ruft die Zeichenfolge ab, die das Element eindeutig für Microsoft Benutzeroberflächenautomatisierung identifiziert, oder legt diese fest. |
| ControlledPeers |
Ruft eine Auflistung von Automatisierungselementen ab, die vom angegebenen Automatisierungselement bearbeitet werden können. |
| Culture |
Ruft den Gebietsschemabezeichner für das Automation-Element ab oder legt diese fest (z. B. 0x0409 für "en-US" oder Englisch (USA)). |
| DescribedBy |
Ruft ein Array von Elementen ab, die weitere Informationen zum Automation-Element bereitstellen. |
| FlowsFrom |
Ruft ein Array von Automatisierungselementen ab, das die Lesereihenfolge vor dem aktuellen Automatisierungselement vorschlägt. |
| FlowsTo |
Ruft ein Array von Automatisierungselementen ab, das die Lesereihenfolge nach dem aktuellen Automatisierungselement vorschlägt. |
| FullDescription |
Ruft eine lokalisierte Zeichenfolge ab, die erweiterten Beschreibungstext für ein Element enthält, oder legt diese fest. |
| HeadingLevel |
Ruft die Überschriftenebene für ein Benutzeroberflächenautomatisierung-Element ab oder legt sie fest. |
| HelpText |
Ruft eine Hilfetextzeichenfolge ab, die dem Automation-Element zugeordnet ist, oder legt diese fest. |
| IsDataValidForForm |
Ruft einen Wert ab, der angibt, ob die Daten für das Formular gültig sind, oder legt diesen fest. |
| IsDialog |
Ruft einen Wert ab, der angibt, ob das Automation-Element ein Dialogfeld ist, oder legt diesen fest. |
| IsPeripheral |
Ruft einen Wert ab, der angibt, ob das Automation-Element die Peripheriebenutzeroberfläche darstellt, oder legt diesen fest. |
| IsRequiredForForm |
Ruft einen Wert ab, der angibt, ob das Element in einem Formular ausgefüllt werden muss, oder legt diesen fest. |
| ItemStatus |
Ruft eine Beschreibung der status eines Elements in einem Element ab oder legt diese fest. |
| ItemType |
Ruft eine Beschreibung des Typs für das angegebene Element ab oder legt diese fest. |
| LabeledBy |
Ruft das Automatisierungselement ab, das die Textbezeichnung für dieses Element enthält, oder legt es fest. |
| LandmarkType |
Ruft einen einem Element zugeordneten Landmark-Typbezeichner ab oder legt diese fest. |
| Level |
Ruft eine 1-basierte ganze Zahl ab, die die Position eines Elements in hierarchischen oder fehlerhaften hierarchischen Strukturen beschreibt, oder legt diese fest. |
| LiveSetting |
Ruft den Liveeinstellungswert für das angegebene Element ab, der von einem Automation-Element unterstützt wird, das einen Livebereich darstellt, oder legt diesen fest. |
| LocalizedControlType |
Ruft eine lokalisierte Textzeichenfolge ab, die den Typ des Steuerelements beschreibt, das das automation-Element darstellt, oder legt diese fest. |
| LocalizedLandmarkType |
Ruft eine lokalisierte Textzeichenfolge ab, die den Typ des Wahrzeichens beschreibt, das das Automation-Element darstellt, oder legt diese fest. |
| Name |
Ruft den Benutzeroberflächenautomatisierung Namen des Elements ab oder legt diese fest. |
| PositionInSet |
Ruft eine 1-basierte ganze Zahl ab, die die Ordnungsposition des Elements in einer Gruppe von Elementen beschreibt, die als gleichgeordnet angesehen werden, oder legt diese fest. |
| SizeOfSet |
Ruft die Anzahl der Elemente in einer Gruppe von Elementen ab, die als gleichgeordnete Elemente betrachtet werden, oder legt diese fest. |