Bagikan melalui

AutomationPeer Kelas

  • Referensi

Definisi

Ruang nama:
Windows.UI.Xaml.Automation.Peers
Edit

Menyediakan kelas dasar yang mengekspos peer otomatisasi untuk kelas pemilik terkait ke Microsoft UI Automation.

public ref class AutomationPeer : DependencyObject
/// [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 AutomationPeer : DependencyObject
[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 class AutomationPeer : DependencyObject
Public Class AutomationPeer
Inherits DependencyObject
Warisan
Object Platform::Object IInspectable DependencyObject AutomationPeer
Turunan
Atribut
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Persyaratan Windows

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

Keterangan

AutomationPeer adalah kelas yang menyediakan hampir semua API yang akhirnya meneruskan informasi Otomatisasi UI Microsoft untuk aplikasi UWP menggunakan C++, C#, atau Visual Basic ke klien Microsoft UI Automation. Klien Automation UI Microsoft yang khas tidak memanggil metode AutomationPeer secara langsung. Klien ini sering kali merupakan teknologi bantu yang menggunakan model pemrograman lain dan beroperasi sebagai layanan, dan tidak mungkin memanggil metode Windows Runtime. Tetapi dukungan Umum Microsoft UI Automation di Windows Runtime meneruskan semua informasi ini menggunakan sisi penyedia kerangka kerja Microsoft UI Automation. Setiap klien ke Microsoft UI Automation dapat berinteraksi dengan pohon otomatisasi perwakilan dari aplikasi UWP menggunakan C++, C#, atau Visual Basic.

Menembakkan peristiwa otomatisasi

Kelas AutomationPeer relevan dengan penulis kontrol Windows Runtime karena Anda akan memiliki instans peer yang tersedia pada durasi, setelah runtime memanggil metode OnCreateAutomationPeer . Dengan menggunakan peer ini, Anda dapat mengaktifkan peristiwa otomatisasi dengan memanggil RaiseAutomationEvent dan RaisePropertyChangedEvent. Anda akan melakukan ini setiap kali properti terkait di pemilik serekan (kelas Anda) berubah, atau saat mengaktifkan peristiwa diperlukan untuk dukungan otomatisasi yang benar.

Desain dukungan otomatisasi tidak mempertahankan handel ke serekan Anda sendiri sebagai bagian dari cara Anda menerapkan OnCreateAutomationPeer, karena tidak ada jaminan kapan serekan benar-benar dibuat. Sebagai gantinya, Anda dapat memeriksa pendengar peristiwa otomatisasi run-time di dalam definisi kelas kontrol Anda tepat waktu, menggunakan kode seperti ini:

if (AutomationPeer.ListenerExists(AutomationEvents.PropertyChanged))
{
    MyAutomationPeer peer = 
        FrameworkElementAutomationPeer.FromElement(myCtrl) as MyAutomationPeer;

    if (peer != null)
    {
        peer.RaisePropertyChangedEvent(
            RangeValuePatternIdentifiers.ValueProperty,
            (double)oldValue,
            (double)newValue);
    }
}

If AutomationPeer.ListenerExists(AutomationEvents.PropertyChanged) Then
    Dim peer As MyAutomationPeer = _
    TryCast(FrameworkElementAutomationPeer.FromElement(myCtrl), MyAutomationPeer)
    If peer IsNot Nothing Then
        peer.RaisePropertyChangedEvent(RangeValuePatternIdentifiers.ValueProperty, CDbl(oldValue), CDbl(newValue))
    End If
End If

Kelas turunan AutomationPeer

AutomationPeer berada dalam hierarki untuk semua rekan yang ada untuk kontrol Windows Runtime dan kelas UI terkait.

Kelas yang langsung berasal dari AutomationPeer adalah:

Metode inti

Metode "Core" adalah implementasi standar yang melakukan tindakan default dari metode yang dapat dipanggil klien Microsoft UI Automation terkait. Anda dapat mengambil alih salah satu metode "Core" untuk mengembalikan nilai alternatif dalam rekan otomatisasi kustom. Misalnya, GetAcceleratorKeyCore dipanggil setiap kali GetAcceleratorKey dipanggil, GetAccessKeyCore dipanggil kapan saja GetAccessKey dipanggil, dan sebagainya.

Implementasi dasar untuk AutomationPeer mengembalikan null. Serekan yang mewakili item dapat menangguhkan hasilnya ke kontainer mereka.

Riwayat versi

Versi Windows Versi SDK Nilai ditambahkan
1511 10586 GetLandmarkType
1511 10586 GetLandmarkTypeCore
1511 10586 GetLocalizedLandmarkType
1511 10586 GetLocalizedLandmarkTypeCore
1607 14393 GetDescribedByCore
1607 14393 GetFlowsFromCore
1607 14393 GetFlowsToCore
1607 14393 GetFullDescription
1607 14393 GetFullDescriptionCore
1607 14393 IsDataValidForForm
1607 14393 IsDataValidForFormCore
1607 14393 IsPeripheral
1607 14393 IsPeripheralCore
1703 15063 GetCulture
1703 15063 GetCultureCore
1709 16299 RaiseNotificationEvent
1803 17134 GetHeadingLevel
1803 17134 GetHeadingLevelCore
1809 17763 IsDialog
1809 17763 IsDialogCore

Konstruktor

AutomationPeer()

Menyediakan perilaku inisialisasi kelas dasar untuk kelas turunan AutomationPeer .

Properti

Dispatcher

Mendapatkan CoreDispatcher yang dikaitkan dengan objek ini. CoreDispatcher mewakili fasilitas yang dapat mengakses DependencyObject pada utas UI meskipun kode dimulai oleh utas non-UI.

(Diperoleh dari DependencyObject)
EventsSource

Mendapatkan atau mengatur AutomationPeer yang dilaporkan ke klien otomatisasi sebagai sumber untuk semua peristiwa yang berasal dari AutomationPeer ini. Lihat Keterangan.

Metode

ClearValue(DependencyProperty)

Menghapus nilai lokal properti dependensi.

(Diperoleh dari DependencyObject)
GenerateRawElementProviderRuntimeId()

Menghasilkan pengidentifikasi runtime untuk elemen yang terkait dengan peer otomatisasi.
GetAcceleratorKey()

Mendapatkan kombinasi kunci akselerator untuk objek yang terkait dengan peer Automation UI.
GetAcceleratorKeyCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetAcceleratorKey atau API klien Microsoft UI Automation yang setara.
GetAccessKey()

Mendapatkan kunci akses untuk elemen yang terkait dengan peer otomatisasi.
GetAccessKeyCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetAccessKey atau API klien Microsoft UI Automation yang setara.
GetAnimationBaseValue(DependencyProperty)

Mengembalikan nilai dasar apa pun yang ditetapkan untuk properti dependensi, yang akan berlaku dalam kasus di mana animasi tidak aktif.

(Diperoleh dari DependencyObject)
GetAnnotations()

Mendapatkan referensi ke daftar anotasi otomatisasi UI untuk peer otomatisasi saat ini.
GetAnnotationsCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetAnnotations atau API klien Microsoft UI Automation yang setara.
GetAutomationControlType()

Mendapatkan jenis kontrol untuk elemen yang terkait dengan peer Automation UI.
GetAutomationControlTypeCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetAutomationControlType atau API klien Microsoft UI Automation yang setara.
GetAutomationId()

Mendapatkan AutomationId dari elemen yang terkait dengan peer otomatisasi.
GetAutomationIdCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetAutomationId atau API klien Microsoft UI Automation yang setara.
GetBoundingRectangle()

Mendapatkan objek Rect yang mewakili koordinat layar elemen yang terkait dengan peer otomatisasi.
GetBoundingRectangleCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetBoundingRectangle atau API klien Microsoft UI Automation yang setara.
GetChildren()

Mendapatkan kumpulan elemen anak yang diwakili di pohon Automation UI sebagai elemen turunan langsung dari peer otomatisasi.
GetChildrenCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetChildren atau API klien Microsoft UI Automation yang setara.
GetClassName()

Mendapatkan nama yang digunakan dengan AutomationControlType, untuk membedakan kontrol yang diwakili oleh AutomationPeer ini.
GetClassNameCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetClassName atau API klien Microsoft UI Automation yang setara.
GetClickablePoint()

Mendapatkan titik pada elemen yang terkait dengan rekan otomatisasi yang merespons klik mouse.
GetClickablePointCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetClickablePoint atau API klien Microsoft UI Automation yang setara.
GetControlledPeers()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetControlledPeers atau API klien Microsoft UI Automation yang setara seperti mendapatkan nilai properti seperti yang diidentifikasi oleh UIA_ControllerForPropertyId.
GetControlledPeersCore()

Mendapatkan daftar serekan terkontrol untuk peer otomatisasi saat ini.
GetCulture()

Memanggil GetCultureCore untuk mendapatkan nilai budaya untuk elemen yang terkait dengan peer otomatisasi.
GetCultureCore()

Mendapatkan nilai budaya untuk elemen yang terkait dengan peer otomatisasi.
GetDescribedByCore()

Mendapatkan kumpulan elemen yang memberikan informasi lebih lanjut tentang elemen otomatisasi.
GetElementFromPoint(Point)

Mendapatkan elemen dari titik yang ditentukan.
GetElementFromPointCore(Point)

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetElementFromPoint atau API klien Microsoft UI Automation yang setara.
GetFlowsFromCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetFlowsFrom atau API klien Microsoft UI Automation yang setara.
GetFlowsToCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetFlowsTo atau API klien Microsoft UI Automation yang setara.
GetFocusedElement()

Mendapatkan elemen yang saat ini memiliki fokus.
GetFocusedElementCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetFocusedElement atau API klien Microsoft UI Automation yang setara.
GetFullDescription()

Mendapatkan string yang dilokalkan yang menjelaskan tampilan visual atau konten aktual dari sesuatu seperti gambar atau kontrol gambar.
GetFullDescriptionCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetFullDescription atau API klien Microsoft UI Automation yang setara.
GetHeadingLevel()

Mendapatkan tingkat judul elemen Automation UI yang terkait dengan peer otomatisasi ini.
GetHeadingLevelCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetHeadingLevel atau API klien Microsoft UI Automation yang setara.
GetHelpText()

Mendapatkan teks yang menjelaskan fungsionalitas kontrol yang terkait dengan peer otomatisasi.
GetHelpTextCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetHelpText atau API klien Microsoft UI Automation yang setara.
GetItemStatus()

Mendapatkan teks yang menyampaikan status visual elemen yang terkait dengan peer otomatisasi ini.
GetItemStatusCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetItemStatus atau API klien Microsoft UI Automation yang setara.
GetItemType()

Mendapatkan string yang menjelaskan jenis item apa yang diwakili elemen.
GetItemTypeCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetItemType atau API klien Microsoft UI Automation yang setara.
GetLabeledBy()

Mendapatkan AutomationPeer untuk UIElement yang ditargetkan ke elemen .
GetLabeledByCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetLabeledBy atau API klien Microsoft UI Automation yang setara.
GetLandmarkType()

Mendapatkan jenis tengara untuk peer otomatisasi ini.
GetLandmarkTypeCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetLandmarkType atau API klien Microsoft UI Automation yang setara.
GetLevel()

Mengembalikan bilangan bulat berbasis 1 untuk tingkat (hierarki) elemen yang terkait dengan peer otomatisasi.
GetLevelCore()

Menyediakan perilaku peer saat klien Microsoft UI Automation memanggil GetLevel atau API klien Microsoft UI Automation yang setara.
GetLiveSetting()

Mendapatkan informasi perilaku pemberitahuan pengaturan langsung untuk objek yang terkait dengan peer Automation UI.
GetLiveSettingCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetLiveSetting atau API klien Microsoft UI Automation yang setara.
GetLocalizedControlType()

Mendapatkan string yang dilokalkan yang mewakili nilai AutomationControlType untuk kontrol yang terkait dengan peer otomatisasi ini.
GetLocalizedControlTypeCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetLocalizedControlType atau API klien Microsoft UI Automation yang setara.
GetLocalizedLandmarkType()

Mendapatkan string yang dilokalkan yang mewakili nilai AutomationLandmarkType untuk elemen yang terkait dengan peer otomatisasi ini.
GetLocalizedLandmarkTypeCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetLocalizedLandmarkType atau API klien Microsoft UI Automation yang setara.
GetName()

Mendapatkan teks yang menjelaskan elemen yang terkait dengan peer otomatisasi ini. Nilai Nama Automasi UI Microsoft adalah pengidentifikasi utama yang digunakan oleh sebagian besar teknologi bantuan saat mewakili UI aplikasi Anda dengan berinteraksi dengan kerangka kerja Microsoft UI Automation.
GetNameCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetName atau API klien Microsoft UI Automation yang setara.
GetOrientation()

Mendapatkan nilai yang menunjukkan orientasi kontrol eksplisit, jika ada.
GetOrientationCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetOrientation atau API klien Microsoft UI Automation yang setara.
GetParent()

Mendapatkan AutomationPeer yang merupakan induk dari AutomationPeer ini.
GetPattern(PatternInterface)

Mendapatkan pola kontrol yang terkait dengan PatternInterface yang ditentukan.
GetPatternCore(PatternInterface)

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetPattern atau API klien Microsoft UI Automation yang setara.
GetPeerFromPoint(Point)

Mendapatkan AutomationPeer dari titik yang ditentukan.
GetPeerFromPointCore(Point)

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetPeerFromPoint atau API klien Microsoft UI Automation yang setara.
GetPositionInSet()

Mengembalikan bilangan bulat berbasis 1 untuk posisi ordinal dalam set untuk elemen yang terkait dengan peer otomatisasi.
GetPositionInSetCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetPositionInSet atau API klien Microsoft UI Automation yang setara.
GetSizeOfSet()

Mengembalikan bilangan bulat berbasis 1 untuk ukuran set tempat elemen yang terkait dengan peer otomatisasi berada.
GetSizeOfSetCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil GetSizeOfSet atau API klien Microsoft UI Automation yang setara.
GetValue(DependencyProperty)

Mengembalikan nilai efektif properti dependensi saat ini dari DependencyObject.

(Diperoleh dari DependencyObject)
HasKeyboardFocus()

Mendapatkan nilai yang menunjukkan apakah elemen yang terkait dengan peer otomatisasi ini saat ini memiliki fokus keyboard.
HasKeyboardFocusCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil HasKeyboardFocus atau API klien Microsoft UI Automation yang setara.
InvalidatePeer()

Memicu perhitungan ulang properti utama AutomationPeer dan menaikkan pemberitahuan PropertyChanged ke klien otomatisasi jika properti telah berubah.
IsContentElement()

Mendapatkan nilai yang menunjukkan apakah elemen yang terkait dengan peer otomatisasi ini berisi data yang disajikan kepada pengguna.
IsContentElementCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil IsContentElement atau API klien Microsoft UI Automation yang setara.
IsControlElement()

Mendapatkan nilai yang menunjukkan apakah elemen dipahami oleh pengguna sebagai interaktif atau berkontribusi pada struktur logis kontrol di GUI.
IsControlElementCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil IsControlElement atau API klien Microsoft UI Automation yang setara.
IsDataValidForForm()

Mendapatkan nilai Boolean yang menunjukkan apakah nilai yang dimasukkan atau dipilih valid untuk aturan formulir yang terkait dengan elemen otomatisasi.
IsDataValidForFormCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation mengakses IsDataValidForForm atau API klien Microsoft UI Automation yang setara.
IsDialog()

Mendapatkan nilai yang menunjukkan apakah elemen yang terkait dengan peer otomatisasi ini adalah jendela dialog.
IsDialogCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil IsDialog atau API klien Microsoft UI Automation yang setara.
IsEnabled()

Mendapatkan nilai yang menunjukkan apakah elemen yang terkait dengan peer otomatisasi ini mendukung interaksi.
IsEnabledCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil IsEnabled atau API klien Microsoft UI Automation yang setara.
IsKeyboardFocusable()

Mendapatkan nilai yang menunjukkan apakah elemen dapat menerima fokus keyboard.
IsKeyboardFocusableCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil IsKeyboardFocusable atau API klien Microsoft UI Automation yang setara.
IsOffscreen()

Mendapatkan nilai yang menunjukkan apakah elemen berada di luar layar.
IsOffscreenCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil IsOffscreen atau API klien Microsoft UI Automation yang setara.
IsPassword()

Mendapatkan nilai yang menunjukkan apakah elemen berisi konten sensitif.
IsPasswordCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil IsPassword atau API klien Microsoft UI Automation yang setara.
IsPeripheral()

Mendapatkan nilai Boolean yang menunjukkan apakah elemen otomatisasi mewakili antarmuka pengguna periferal.
IsPeripheralCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation mengakses IsPeripheral atau API klien Microsoft UI Automation yang setara.
IsRequiredForForm()

Mendapatkan nilai yang menunjukkan apakah elemen yang terkait dengan serekan ini harus diselesaikan pada formulir.
IsRequiredForFormCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil IsRequiredForForm atau API klien Microsoft UI Automation yang setara.
ListenerExists(AutomationEvents)

Mendapatkan nilai yang menunjukkan apakah Microsoft UI Automation melaporkan bahwa klien mendengarkan peristiwa yang ditentukan.
Navigate(AutomationNavigationDirection)

Mendapatkan elemen ke arah yang ditentukan dalam pohon otomatisasi UI.
NavigateCore(AutomationNavigationDirection)

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil Navigate atau API klien Microsoft UI Automation yang setara.
PeerFromProvider(IRawElementProviderSimple)

Mendapatkan AutomationPeer untuk proksi IRawElementProviderSimple yang ditentukan.
ProviderFromPeer(AutomationPeer)

Mendapatkan proksi IRawElementProviderSimple untuk AutomationPeer yang ditentukan.
RaiseAutomationEvent(AutomationEvents)

Menaikkan peristiwa otomatisasi.
RaiseNotificationEvent(AutomationNotificationKind, AutomationNotificationProcessing, String, String)

Memulai peristiwa pemberitahuan.
RaisePropertyChangedEvent(AutomationProperty, Object, Object)

Memunculkan peristiwa untuk memberi tahu klien otomatisasi tentang nilai properti yang diubah.
RaiseStructureChangedEvent(AutomationStructureChangeType, AutomationPeer)

Memunculkan peristiwa untuk memberi tahu inti Microsoft UI Automation bahwa struktur pohon telah berubah.
RaiseTextEditTextChangedEvent(AutomationTextEditChangeType, IVectorView<String>)

Memunculkan peristiwa untuk memberi tahu inti Microsoft UI Automation bahwa kontrol teks telah mengubah teks secara terprogram.
ReadLocalValue(DependencyProperty)

Mengembalikan nilai lokal properti dependensi, jika nilai lokal ditetapkan.

(Diperoleh dari DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

Mendaftarkan fungsi pemberitahuan untuk mendengarkan perubahan pada DependencyProperty tertentu pada instans DependencyObject ini.

(Diperoleh dari DependencyObject)
SetFocus()

Mengatur fokus keyboard pada elemen yang terkait dengan peer otomatisasi ini.
SetFocusCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil SetFocus atau API klien Microsoft UI Automation yang setara.
SetParent(AutomationPeer)

Mengatur AutomationPeer yang merupakan induk dari AutomationPeer ini.
SetValue(DependencyProperty, Object)

Mengatur nilai lokal properti dependensi pada DependencyObject.

(Diperoleh dari DependencyObject)
ShowContextMenu()

Memperlihatkan menu konteks yang tersedia untuk elemen pemilik.
ShowContextMenuCore()

Menyediakan perilaku serekan saat klien Microsoft UI Automation memanggil ShowContextMenu atau API klien Microsoft UI Automation yang setara.
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Membatalkan pemberitahuan perubahan yang sebelumnya terdaftar dengan memanggil RegisterPropertyChangedCallback.

(Diperoleh dari DependencyObject)

Berlaku untuk

Lihat juga