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(Microsoft.UI.Xaml.WinUIContract, 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(Microsoft.UI.Xaml.WinUIContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class AutomationProperties
Public NotInheritable Class AutomationProperties
- Vererbung
- Attribute
Hinweise
Angefügte XAML-Eigenschaften
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 Barrierefreiheitsframework der Microsoft-Benutzeroberflächenautomatisierung 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 UI Automation-Integrations- oder Peerimplementierungsverhaltens weiterleitet oder der weitergeleitete Wert nicht der Wert ist, den Sie microsoft UI Automation melden möchten.
Um den XAML-Prozessorzugriff auf die angefügten Eigenschaften zu unterstützen und auch äquivalente 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 UI Automation, 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 UI Automation 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. Legen Sie die angefügte Name-Eigenschaft für dieses Element in XAML fest, um diese Standardeinstellung außer Kraft zu setzen oder auf andere Weise einen Name-Wert für alle Benutzeroberflächenelemente anzugeben, in denen kein Microsoft-Benutzeroberflächenautomatisierungsname verfügbar ist. Weitere Informationen dazu, warum ein Name der Microsoft-Benutzeroberflächenautomatisierung 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
Angefügte Eigenschaften
Hinweis
Weitere Informationen zu den einzelnen angefügten Eigenschaften finden Sie auf der Seite für das Bezeichnerfeld der Eigenschaft.
Angefügte Eigenschaft | BESCHREIBUNG |
---|---|
AcceleratorKey | Ruft die Tastenkombination für ein bestimmtes Element ab oder legt diese fest.
|
AccessibilityView | Ruft den Microsoft UI Automation-Strukturansichtsmodus für ein Element ab oder legt diese fest.
|
AccessKey | Dient zum Abrufen oder Festlegen des Zugriffsschlüssels für das angegebene Element.
|
AutomationID | Ruft die Zeichenfolge ab, die das Element eindeutig für Microsoft UI Automation identifiziert, oder legt diese fest.
|
Kultur | Ruft den Gebietsschemabezeichner für das Automation-Element ab oder legt diese fest (z. B. 0x0409 für "en-US" oder Englisch (USA)).
|
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ächenautomatisierungselement ab oder legt diese fest.
|
HelpText | Ruft den Hilfetext für das Element ab oder legt den Hilfetext 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 Peripherie-Benutzeroberfläche darstellt, oder legt diesen fest.
|
Isrequiredforform | Ruft einen Wert ab, der angibt, ob das Element für ein 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 Element ab, das die Textbezeichnung für das -Element enthält, oder legt es fest.
|
LandmarkType | Ruft einen Landmark Type Identifier ab, der einem Element zugeordnet ist, oder legt diese fest.
|
Ebene | 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 oder legt diese 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 Orientierungspunkts beschreibt, den das Automation-Element darstellt, oder legt diese fest.
|
Name | Ruft den Benutzeroberflächenautomatisierungsnamen 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 gelten.
|
SizeOfSet | Ruft die Anzahl der Elemente in einer Gruppe von Elementen ab, die als gleichgeordnet gelten, oder legt diese fest.
|
Eigenschaften
AcceleratorKeyProperty |
Gibt die angefügte AutomationProperties.AcceleratorKey-Eigenschaft an. Hierbei handelt es sich um eine Zeichenfolge, die die Kombinationen der Tastenkombination (auch Tastenkombination genannt) für das Automatisierungselement enthält. |
AccessibilityViewProperty |
Identifiziert die angefügte AutomationProperties.AccessibilityView-Eigenschaft . Legen Sie diese angefügte Eigenschaft für einzelne Elemente fest, um deren Elementsichtbarkeit in bestimmte Modi zu ändern, die von einem Benutzeroberflächenautomatisierungsclient angefordert werden. |
AccessKeyProperty |
Identifiziert die angefügte AutomationProperties.AccessKey-Eigenschaft , bei der es sich um eine Zeichenfolge handelt, die das Zugriffsschlüsselzeichen für das Automation-Element enthält. |
AnnotationsProperty |
Identifiziert eine Abhängigkeitseigenschaft, die für eine Liste von Anmerkungsobjekten in einem Dokument verwendet wird, z. B. Kommentar, Kopfzeile, Fußzeile usw. |
AutomationControlTypeProperty |
Gibt die AutomationProperties angefügte Eigenschaft an, bei der es sich um eine Microsoft.UI.Xaml.Automation.Peers.AutomationControlTypehandelt. |
AutomationIdProperty |
Gibt die angefügte AutomationProperties.AutomationId-Eigenschaft an. Hierbei handelt es sich um eine Zeichenfolge, die den UI Automation-Bezeichner (ID) für das Automation-Element enthält. |
ControlledPeersProperty |
Gibt die angefügte ControlledPeers-Eigenschaft an, die für eine Auflistung von Automatisierungselementen verwendet wird, die vom angegebenen Automatisierungselement bearbeitet werden können. |
CultureProperty |
Ruft den Bezeichner für die kulturbezogene Eigenschaft ab, die einen Gebietsschemabezeichner für das Automatisierungselement enthält (z. B. 0x0409 für "en-US" oder Englisch (USA)). |
DescribedByProperty |
Ruft den Bezeichner für die beschriebene by angefügte Eigenschaft ab, bei der es sich um ein Array von Elementen handelt, die weitere Informationen zum Automation-Element bereitstellen. |
FlowsFromProperty |
Ruft den Bezeichner für die angefügte FlowsFrom-Eigenschaft ab, bei der es sich um ein Array von Automatisierungselementen handelt, das die Lesereihenfolge vor dem aktuellen Automatisierungselement vorschlägt. |
FlowsToProperty |
Ruft den Bezeichner für die angefügte FlowsTo-Eigenschaft ab, bei der es sich um ein Array von Automatisierungselementen handelt, das die Lesereihenfolge nach dem aktuellen Automatisierungselement vorschlägt. |
FullDescriptionProperty |
Ruft den Bezeichner für die an die vollständige Beschreibung angefügte Eigenschaft ab, die eine lokalisierte Zeichenfolge mit erweitertem Beschreibungstext für ein Element verfügbar macht. |
HeadingLevelProperty |
Ruft den Bezeichner für die angefügte HeadingLevel-Eigenschaft ab, die die Überschriftenebene für ein UI Automation-Element angibt. |
HelpTextProperty |
Gibt die angefügte AutomationProperties.HelpText-Eigenschaft an, bei der es sich um eine Hilfetextzeichenfolge handelt, die dem Automation-Element zugeordnet ist. |
IsDataValidForFormProperty |
Gibt die boolesche Abhängigkeitseigenschaft an, die angibt, ob die Daten für das Formular gültig sind. |
IsDialogProperty |
Gibt die angefügte AutomationProperties.IsDialog-Eigenschaft an. Hierbei handelt es sich um einen booleschen Wert, der angibt, ob das Automation-Element ein Dialogfeld ist. |
IsPeripheralProperty |
Gibt die boolesche Abhängigkeitseigenschaft an, die angibt, ob das Automation-Element die Peripheriebenutzeroberfläche darstellt. |
IsRequiredForFormProperty |
Identifiziert die angefügte AutomationProperties.IsRequiredForForm-Eigenschaft , bei der es sich um einen booleschen Wert handelt, der angibt, ob das Automation-Element für ein Formular ausgefüllt werden muss. |
ItemStatusProperty |
Gibt die angefügte ItemStatus-Eigenschaft an, die die status eines Automatisierungselementelements beschreibt. |
ItemTypeProperty |
Identifiziert die angefügte AutomationProperties.ItemType-Eigenschaft , bei der es sich um eine Textzeichenfolge handelt, die den Typ des Automation-Elements beschreibt. |
LabeledByProperty |
Identifiziert die angefügte AutomationProperties.LabeledBy-Eigenschaft , bei der es sich um ein Automatisierungselement handelt, das die Textbezeichnung für dieses Element enthält. |
LandmarkTypeProperty |
Ruft den Bezeichner für die angefügte Eigenschaft des Landmark-Typs ab, bei der es sich um einen Landmark Type Identifier handelt, der einem Element zugeordnet ist. |
LevelProperty |
Ruft den Bezeichner für die angefügte Level-Eigenschaft ab, bei der es sich um eine 1-basierte ganze Zahl handelt, die einem Automatisierungselement zugeordnet ist. |
LiveSettingProperty |
Identifiziert die angefügte AutomationProperties.LiveSetting-Eigenschaft , die von einem Automation-Element unterstützt wird, das eine Liveregion darstellt. |
LocalizedControlTypeProperty |
Gibt die Abhängigkeitseigenschaft des lokalisierten Steuerelementtyps an. Hierbei handelt es sich um eine Textzeichenfolge, die den Typ des Steuerelements beschreibt, den das Automation-Element darstellt. |
LocalizedLandmarkTypeProperty |
Ruft den Bezeichner für die angefügte Eigenschaft des lokalisierten Orientierungspunkttyps ab. Hierbei handelt es sich um eine lokalisierte Textzeichenfolge, die den Typ des Landmarks beschreibt, den das Automation-Element darstellt. |
NameProperty |
Gibt die AutomationProperties.Name angefügte Eigenschaft an. Hierbei handelt es sich um eine Zeichenfolge, die den Namen des Automatisierungselements enthält. |
PositionInSetProperty |
Ruft den Bezeichner für die angefügte PositionInSet-Eigenschaft ab, bei der es sich um eine 1-basierte Ganzzahl handelt, die einem Automatisierungselement zugeordnet ist. |
SizeOfSetProperty |
Ruft den Bezeichner für die angefügte Eigenschaft ab. |
Angefügte Eigenschaften
AcceleratorKey |
Ruft eine Zeichenfolge ab, die die Tastenkombinationen für das Automatisierungselement enthält, oder legt sie fest. |
AccessibilityView |
Ruft den Microsoft UI Automation-Strukturansichtsmodus für ein Element ab oder legt diese fest. |
AccessKey |
Ruft eine Zeichenfolge ab, die das Zugriffsschlüsselzeichen für das Automation-Element enthält, oder legt diese fest. |
Annotations |
Ruft eine Liste der Anmerkungsobjekte in einem Dokument ab, z. B. Kommentar, Kopfzeile, Fußzeile usw. |
AutomationControlType |
Gibt den Typ des Benutzeroberflächenelements an, das für den Microsoft UI Automation-Client verfügbar gemacht wird. |
AutomationId |
Ruft die Zeichenfolge ab, die das Element eindeutig für Microsoft UI Automation 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 Automatisierungselement 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 UI Automation-Element ab oder legt diese 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 Peripherie-Benutzeroberfläche darstellt, oder legt diesen fest. |
IsRequiredForForm |
Ruft einen Wert ab, der angibt, ob das Element für ein 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 Landmark Type Identifier ab, der einem Element zugeordnet ist, 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 Automatisierungselement unterstützt wird, das eine Liveregion 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 Orientierungspunkts beschreibt, den das Automation-Element darstellt, oder legt diese fest. |
Name |
Ruft den Benutzeroberflächenautomatisierungsnamen 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 gelten. |
SizeOfSet |
Ruft die Anzahl der Elemente in einer Gruppe von Elementen ab, die als gleichgeordnete Elemente betrachtet werden, oder legt diese fest. |