AutomationProperties Kelas

Definisi

Menyediakan dukungan untuk mendapatkan atau mengatur nilai tingkat instans properti otomatisasi. Nilai properti ini ditetapkan sebagai properti terlampir (biasanya dalam XAML) dan melengkapi atau menimpa nilai properti otomatisasi dari AutomationPeer kontrol.

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 AutomationProperties
Public NotInheritable Class AutomationProperties
Warisan
Object Platform::Object IInspectable AutomationProperties
Atribut

Persyaratan Windows

Rangkaian perangkat
Windows 10 (diperkenalkan dalam 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (diperkenalkan dalam v1.0)

Contoh

Tip

Buka aplikasi Galeri WinUI 3 dan lihat prinsip Aksesibilitas berikut ini dalam tindakan:

Aplikasi WinUI 3 Gallery mencakup contoh interaktif sebagian besar kontrol, fitur, dan fungsi WinUI 3. Dapatkan aplikasi dari Microsoft Store atau dapatkan kode sumber di GitHub

Keterangan

AutomationProperties adalah kelas layanan host untuk beberapa properti terlampir XAML. Tujuan dari properti terlampir ini adalah untuk mengaktifkan pengaturan berbagai nilai per instans yang berkaitan dengan bagaimana elemen UI dilaporkan ke kerangka kerja aksesibilitas Microsoft UI Automation. Ini berguna dalam kasus di mana desain kelas elemen UI belum meneruskan nilai properti terkait UI lainnya sebagai bagian dari integrasi Microsoft UI Automation atau perilaku implementasi serekan, atau di mana nilai yang diteruskan bukan nilai yang ingin Anda laporkan ke Microsoft UI Automation.

Untuk mendukung akses prosesor XAML ke properti terlampir, dan juga untuk mengekspos operasi dapatkan dan atur yang setara ke kode, setiap properti terlampir XAML memiliki sepasang metode aksesor Get and Set , yang juga merupakan anggota AutomationProperties. Misalnya, metode GetName dan SetName mendukung dan memberikan dukungan khusus kode yang setara untuk melaporkan nilai Nama otomatisasi ke Otomatisasi UI Microsoft, alih-alih menggunakan properti Terlampir Nama untuk mengaturnya di XAML. Atau, Anda dapat menggunakan sistem properti dependensi untuk mendapatkan atau mengatur nilai properti terlampir, dan ini juga melaporkan nilai yang mendasar ke Microsoft UI Automation. Panggil GetValue atau SetValue, meneruskan argumen pengidentifikasi properti dependensi untuk diatur, dan referensi ke objek target untuk mendapatkan atau mengatur nilai.

Properti nama

Dari berbagai properti terlampir, mungkin yang paling penting adalah Nama. Ini karena ini adalah properti Nama yang paling sering diakses dan dilaporkan oleh teknologi bantuan ketika pengguna berinteraksi dengan aplikasi dalam skenario aksesibilitas. Nama berfungsi sebagai pengidentifikasi yang dapat dibaca manusia untuk elemen UI.

Berbagai elemen UI memiliki penerusan peer yang dapat memberikan nilai Nama default berdasarkan properti elemen lainnya. Misalnya, penerusan serekan untuk kelas Tombol akan meneruskan evaluasi ToString dari konten Tombol dan menggunakan string ini sebagai Nama default. Untuk mengambil alih default tersebut, atau untuk memberikan nilai Nama untuk setiap kasus elemen UI di mana tidak ada Nama Otomatisasi UI Microsoft yang tersedia, atur properti Terlampir nama pada elemen tersebut di XAML. Untuk informasi selengkapnya tentang mengapa Nama Otomatisasi UI Microsoft penting, lihat Informasi aksesibilitas dasar. Untuk informasi selengkapnya tentang cara menguji apakah elemen sudah memiliki Nama yang disediakan serekan yang berguna, lihat Pengujian aksesibilitas.

Untuk alasan pelokalan, Anda harus menghindari nilai string yang dikodekan secara permanen untuk Nama di XAML. Jika Anda mengatur direktif x:Uid pada elemen , maka Anda dapat menggunakan sumber daya RESW untuk menargetkan properti dan memberikan nilai yang berbeda untuk pelokalan. Untuk properti terlampir, formulir pengidentifikasi sumber daya memerlukan kualifikasi penuh properti terlampir dalam formulir XAML, termasuk namespace layanannya dan menggunakan: awalan. Misalnya, untuk menargetkan nilai properti terlampir AutomationProperties.Name pada sumber daya yang memiliki nilai direktif x:Uid "sendButton", nilai nama item data dalam sumber daya RESW adalah sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name

Lihat Properti terlampir untuk daftar lengkap (untuk informasi selengkapnya tentang setiap properti terlampir, lihat bidang Pengidentifikasi setiap properti).

Riwayat versi

Versi Windows Versi SDK Nilai ditambahkan
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

Properti

AcceleratorKeyProperty

Mengidentifikasi properti terlampir AutomationProperties.AcceleratorKey .

AccessibilityViewProperty

Mengidentifikasi properti terlampir AutomationProperties.AccessibilityView .

AccessKeyProperty

Mengidentifikasi properti terlampir AutomationProperties.AccessKey .

AnnotationsProperty

Mengidentifikasi properti terlampir AutomationProperties.Annotations .

AutomationControlTypeProperty

Mengidentifikasi properti terlampir AutomationProperties.AutomationControlType .

AutomationIdProperty

Mengidentifikasi properti terlampir AutomationProperties.AutomationId .

ControlledPeersProperty

Mengidentifikasi properti terlampir AutomationProperties.ControlledPeers .

CultureProperty

Mengidentifikasi properti terlampir AutomationProperties.Culture .

DescribedByProperty

Mengidentifikasi properti terlampir AutomationProperties.DescribedBy .

FlowsFromProperty

Mengidentifikasi properti FlowsFrom terlampir.

FlowsToProperty

Mengidentifikasi properti terlampir FlowsTo .

FullDescriptionProperty

Mengidentifikasi properti terlampir AutomationProperties.FullDescription XAML.

HeadingLevelProperty

Mengidentifikasi properti terlampir HeadingLevel XAML.

HelpTextProperty

Mengidentifikasi properti terlampir AutomationProperties.HelpText XAML.

IsDataValidForFormProperty

Mengidentifikasi properti terlampir AutomationProperties.IsDataValidForForm XAML.

IsDialogProperty

Mengidentifikasi properti terlampir AutomationProperties.IsDialog XAML.

IsPeripheralProperty

Mengidentifikasi properti terlampir AutomationProperties.IsPeripheral XAML.

IsRequiredForFormProperty

Mengidentifikasi properti terlampir AutomationProperties.IsRequiredForForm XAML.

ItemStatusProperty

Mengidentifikasi properti Terlampir AutomationProperties.ItemStatus XAML.

ItemTypeProperty

Mengidentifikasi properti terlampir AutomationProperties.ItemType XAML.

LabeledByProperty

Mengidentifikasi properti terlampir AutomationProperties.LabeledBy XAML.

LandmarkTypeProperty

Mengidentifikasi properti terlampir AutomationProperties.LandmarkType XAML.

LevelProperty

Mengidentifikasi properti terlampir AutomationProperties.Level XAML.

LiveSettingProperty

Mengidentifikasi properti terlampir AutomationProperties.LiveSetting XAML.

LocalizedControlTypeProperty

Mengidentifikasi properti terlampir AutomationProperties.LocalizedControlType XAML, yang merupakan string teks yang menjelaskan jenis kontrol yang diwakili elemen otomatisasi.

LocalizedLandmarkTypeProperty

Mengidentifikasi properti terlampir AutomationProperties.LocalizedLandmarkType XAML.

NameProperty

Mengidentifikasi properti terlampir AutomationProperties.Name XAML.

PositionInSetProperty

Mengidentifikasi properti terlampir AutomationProperties.PositionInSet XAML.

SizeOfSetProperty

Mengidentifikasi properti terpasang AutomationProperties.SizeOfSet XAML.

Properti yang Terlampir

AcceleratorKey

Mendapatkan atau mengatur string yang berisi kombinasi tombol akselerator (juga disebut tombol pintasan) untuk elemen otomatisasi.

AccessibilityView

Mendapatkan atau mengatur mode tampilan pohon Microsoft UI Automation untuk elemen.

AccessKey

Mendapatkan atau mengatur string yang berisi karakter kunci akses untuk elemen otomatisasi.

Annotations

Mendapatkan daftar objek anotasi dalam dokumen, seperti komentar, header, footer, dan sebagainya.

AutomationControlType

Mendapatkan atau mengatur jenis kontrol untuk Microsoft UI Automation.

AutomationId

Mendapatkan atau mengatur string yang secara unik mengidentifikasi elemen ke Microsoft UI Automation.

ControlledPeers

Mendapatkan kumpulan elemen otomatisasi yang dapat dimanipulasi oleh elemen otomatisasi yang ditentukan.

Culture

Mendapatkan atau mengatur pengidentifikasi lokal untuk elemen otomatisasi (misalnya, 0x0409 untuk "en-US" atau English (Amerika Serikat)).

DescribedBy

Mendapatkan array elemen yang memberikan informasi selengkapnya tentang elemen otomatisasi.

FlowsFrom

Mendapatkan array elemen otomatisasi yang menyarankan urutan baca sebelum elemen otomatisasi saat ini.

FlowsTo

Mendapatkan array elemen otomatisasi yang menyarankan urutan baca setelah elemen otomatisasi saat ini.

FullDescription

Mendapatkan atau mengatur string yang dilokalkan yang berisi teks deskripsi yang diperluas untuk elemen.

HeadingLevel

Mendapatkan atau mengatur tingkat judul untuk elemen Automation UI.

HelpText

Mendapatkan atau mengatur string teks bantuan yang terkait dengan elemen otomatisasi.

IsDataValidForForm

Mendapatkan atau menetapkan nilai yang menunjukkan apakah data valid untuk formulir.

IsDialog

Mendapatkan atau menetapkan nilai yang menunjukkan apakah elemen otomatisasi adalah jendela dialog.

IsPeripheral

Mendapatkan atau menetapkan nilai yang menunjukkan apakah elemen otomatisasi mewakili UI periferal.

IsRequiredForForm

Mendapatkan atau menetapkan nilai yang menunjukkan apakah elemen diperlukan untuk diisi pada formulir.

ItemStatus

Mendapatkan atau mengatur deskripsi status item dalam elemen.

ItemType

Mendapatkan atau mengatur deskripsi jenis elemen yang ditentukan.

LabeledBy

Mendapatkan atau mengatur elemen otomatisasi yang berisi label teks untuk elemen ini.

LandmarkType

Mendapatkan atau mengatur Pengidentifikasi Jenis Tengara yang terkait dengan elemen.

Level

Mendapatkan atau mengatur bilangan bulat berbasis 1 yang menjelaskan lokasi elemen di dalam struktur hierarkis atau rusak.

LiveSetting

Mendapatkan atau mengatur nilai pengaturan langsung untuk elemen yang ditentukan, yang didukung oleh elemen otomatisasi yang mewakili wilayah langsung.

LocalizedControlType

Mendapatkan atau mengatur string teks yang dilokalkan yang menjelaskan jenis kontrol yang diwakili elemen otomatisasi.

LocalizedLandmarkType

Mendapatkan atau mengatur string teks yang dilokalkan yang menjelaskan jenis tengara yang diwakili elemen otomatisasi.

Name

Mendapatkan atau mengatur nama Automation UI dari elemen .

PositionInSet

Mendapatkan atau menetapkan bilangan bulat berbasis 1 yang menjelaskan lokasi ordinal elemen dalam satu set elemen yang dianggap sebagai saudara kandung.

SizeOfSet

Mendapatkan atau mengatur jumlah elemen dalam sekumpulan elemen yang dianggap sebagai saudara kandung.

Metode

GetAcceleratorKey(DependencyObject)

Mendapatkan nilai properti terlampir AutomationProperties.AcceleratorKey untuk DependencyObject yang ditentukan.

GetAccessibilityView(DependencyObject)

Mendapatkan nilai properti terlampir AutomationProperties.AccessibilityView untuk DependencyObject yang ditentukan.

GetAccessKey(DependencyObject)

Mendapatkan nilai properti Terlampir AutomationProperties.AccessKey untuk DependencyObject yang ditentukan.

GetAnnotations(DependencyObject)

Mendapatkan nilai properti AutomationProperties.Annotations untuk DependencyObject yang ditentukan.

GetAutomationControlType(UIElement)

Mendapatkan nilai properti terlampir AutomationProperties.AutomationControlType untuk DependencyObject yang ditentukan.

GetAutomationId(DependencyObject)

Mendapatkan nilai properti terlampir AutomationProperties.AutomationId untuk DependencyObject yang ditentukan.

GetControlledPeers(DependencyObject)

Metode utilitas statis yang mengambil daftar rekan terkontrol dari pemilik target.

GetCulture(DependencyObject)

Mendapatkan nilai properti terlampir Culture XAML untuk DependencyObject yang ditentukan.

GetDescribedBy(DependencyObject)

Mendapatkan kumpulan elemen yang memberikan informasi selengkapnya tentang elemen otomatisasi yang ditentukan.

GetFlowsFrom(DependencyObject)

Mendapatkan daftar elemen otomatisasi yang menyarankan urutan baca sebelum elemen otomatisasi yang ditentukan.

GetFlowsTo(DependencyObject)

Mendapatkan daftar elemen otomatisasi yang menyarankan urutan baca setelah elemen otomatisasi yang ditentukan.

GetFullDescription(DependencyObject)

Mendapatkan nilai properti AutomationProperties.FullDescription untuk DependencyObject yang ditentukan.

GetHeadingLevel(DependencyObject)

Mendapatkan nilai properti AutomationProperties.HeadingLevel untuk DependencyObject yang ditentukan.

GetHelpText(DependencyObject)

Mendapatkan nilai properti terlampir AutomationProperties.HelpText untuk DependencyObject yang ditentukan.

GetIsDataValidForForm(DependencyObject)

Mendapatkan nilai properti AutomationProperties.IsDataValidForForm untuk DependencyObject yang ditentukan.

GetIsDialog(DependencyObject)

Mendapatkan nilai properti Terlampir AutomationProperties.IsDialog untuk DependencyObject yang ditentukan.

GetIsPeripheral(DependencyObject)

Mendapatkan nilai Boolean yang menunjukkan apakah elemen yang ditentukan mewakili UI periferal.

GetIsRequiredForForm(DependencyObject)

Mendapatkan nilai properti terlampir AutomationProperties.IsRequiredForForm untuk DependencyObject yang ditentukan.

GetItemStatus(DependencyObject)

Mendapatkan nilai properti terlampir AutomationProperties.ItemStatus untuk DependencyObject yang ditentukan.

GetItemType(DependencyObject)

Mendapatkan nilai properti terlampir AutomationProperties.ItemType untuk DependencyObject yang ditentukan.

GetLabeledBy(DependencyObject)

Mendapatkan nilai properti terlampir AutomationProperties.LabeledBy untuk DependencyObject yang ditentukan.

GetLandmarkType(DependencyObject)

Mendapatkan nilai properti terlampir jenis landmark untuk DependencyObject yang ditentukan.

GetLevel(DependencyObject)

Mendapatkan nilai properti AutomationProperties.Level untuk elemen yang ditentukan.

GetLiveSetting(DependencyObject)

Mendapatkan nilai properti terlampir AutomationProperties.LiveSetting untuk DependencyObject yang ditentukan.

GetLocalizedControlType(DependencyObject)

Mendapatkan string yang dilokalkan yang menunjukkan jenis kontrol yang ditentukan.

GetLocalizedLandmarkType(DependencyObject)

Mendapatkan nilai properti terlampir jenis landmark yang dilokalkan untuk DependencyObject yang ditentukan.

GetName(DependencyObject)

Mendapatkan nilai properti terlampir AutomationProperties.Name untuk DependencyObject yang ditentukan.

GetPositionInSet(DependencyObject)

Mendapatkan nilai properti AutomationProperties.PositionInSet untuk DependencyObject yang ditentukan.

GetSizeOfSet(DependencyObject)

Mendapatkan nilai properti AutomationProperties.SizeOfSet untuk DependencyObject yang ditentukan.

SetAcceleratorKey(DependencyObject, String)

Mengatur nilai properti terlampir AutomationProperties.AcceleratorKey untuk DependencyObject yang ditentukan.

SetAccessibilityView(DependencyObject, AccessibilityView)

Mengatur nilai properti terlampir AutomationProperties.AccessibilityView untuk DependencyObject yang ditentukan.

SetAccessKey(DependencyObject, String)

Mengatur nilai properti terlampir AutomationProperties.AccessKey untuk DependencyObject yang ditentukan.

SetAutomationControlType(UIElement, AutomationControlType)

Mengatur nilai properti terlampir AutomationProperties.AutomationControlType untuk DependencyObject yang ditentukan.

SetAutomationId(DependencyObject, String)

Mengatur nilai properti terlampir AutomationProperties.AutomationId untuk DependencyObject yang ditentukan.

SetCulture(DependencyObject, Int32)

Mengatur nilai properti Terlampir Budaya untuk DependencyObject yang ditentukan.

SetFullDescription(DependencyObject, String)

Mengatur string yang dilokalkan yang menjelaskan tampilan visual atau konten DependencyObject yang ditentukan.

SetHeadingLevel(DependencyObject, AutomationHeadingLevel)

Mengatur nilai properti AutomationProperties.HeadingLevel untuk DependencyObject yang ditentukan.

SetHelpText(DependencyObject, String)

Mengatur nilai properti terlampir AutomationProperties.HelpText untuk DependencyObject yang ditentukan.

SetIsDataValidForForm(DependencyObject, Boolean)

Mengatur nilai Boolean yang menunjukkan apakah nilai yang dimasukkan atau dipilih valid untuk aturan formulir yang terkait dengan elemen yang ditentukan.

SetIsDialog(DependencyObject, Boolean)

Mengatur nilai Boolean yang menunjukkan apakah elemen yang ditentukan harus diidentifikasi sebagai jendela dialog.

SetIsPeripheral(DependencyObject, Boolean)

Menetapkan nilai Boolean yang menunjukkan apakah elemen yang ditentukan mewakili UI periferal.

SetIsRequiredForForm(DependencyObject, Boolean)

Mengatur nilai properti terlampir AutomationProperties.IsRequiredForForm untuk DependencyObject yang ditentukan.

SetItemStatus(DependencyObject, String)

Mengatur nilai properti Terlampir AutomationProperties.ItemStatus untuk DependencyObject yang ditentukan.

SetItemType(DependencyObject, String)

Mengatur nilai properti terlampir AutomationProperties.ItemType untuk DependencyObject yang ditentukan.

SetLabeledBy(DependencyObject, UIElement)

Mengatur nilai properti terlampir AutomationProperties.LabeledBy untuk DependencyObject yang ditentukan.

SetLandmarkType(DependencyObject, AutomationLandmarkType)

Mengatur nilai properti terlampir jenis tengara untuk DependencyObject yang ditentukan.

SetLevel(DependencyObject, Int32)

Mengatur nilai properti terlampir AutomationProperties.Level untuk DependencyObject yang ditentukan.

SetLiveSetting(DependencyObject, AutomationLiveSetting)

Mengatur nilai properti terlampir AutomationProperties.LiveSetting untuk DependencyObject yang ditentukan.

SetLocalizedControlType(DependencyObject, String)

Mengatur string yang dilokalkan yang menunjukkan jenis kontrol yang ditentukan.

SetLocalizedLandmarkType(DependencyObject, String)

Mengatur nilai properti terlampir jenis landmark yang dilokalkan untuk DependencyObject yang ditentukan.

SetName(DependencyObject, String)

Mengatur nilai properti terlampir AutomationProperties.Name untuk DependencyObject yang ditentukan.

SetPositionInSet(DependencyObject, Int32)

Mengatur nilai properti terlampir AutomationProperties.PositionInSet untuk DependencyObject yang ditentukan.

SetSizeOfSet(DependencyObject, Int32)

Mengatur nilai properti terlampir AutomationProperties.SizeOfSet untuk DependencyObject yang ditentukan.

Berlaku untuk

Lihat juga