AutomationProperties 類別
定義
重要
部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。
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 AutomationPropertiesPublic NotInheritable Class AutomationProperties- 繼承
- 屬性
備註
XAML 附加屬性
AutomationProperties 是數個 XAML 附加屬性的主機服務類別，。 這些附加屬性的目的是要啟用設定與UI元素如何回報至 Microsoft UI 自動化輔助功能架構相關的各種個別實例值。 在UI元素的類別設計尚未轉送其他UI相關屬性值作為其Microsoft UI自動化整合或對等實作行為的一部分，或者所轉送的值不是您想要向UI自動化 Microsoft回報的值時，這非常有用。
為了支援 XAML 處理器存取附加屬性，以及公開對等的 get 和 set 作業給程式代碼，每個 XAML 附加屬性都有一對 Get 和 Set 存取子方法，這也是 AutomationProperties 的成員。 例如，GetName 和 SetName 方法支援，並提供對等程式碼僅支援將自動化 Name 值回報給 Microsoft UI 自動化，而不是使用 Name 附加屬性在 XAML 中設定它。 或者，您可以使用相依性屬性系統來取得或設定附加屬性的值，這也會報告基礎值以Microsoft UI 自動化。 呼叫 GetValue 或 SetValue、傳遞要設定之相依性屬性標識符的自變數，以及要取得或設定值的目標對象的參考。
Name 屬性
在各種附加屬性中，最重要的屬性可能是 Name。 這是因為它是 Name 屬性，當用戶在輔助功能案例中與應用程式互動時，最常由輔助技術存取和報告。 Name 可作為 UI 元素的人類可讀取識別碼。
各種UI元素都有對等轉送，可根據其他元素屬性提供預設 Name 值。 例如，Button 類別的對等轉送會轉送 ToString 評估 Button 內容，並使用此字串作為預設 Name。 若要覆寫該預設值，或為任何 UI 元素提供 Name 值，如果沒有Microsoft UI 自動化 Name 可用，請在 XAML 中設定 Name 附加屬性。 如需為何Microsoft使用者介面自動化 名稱 很重要的詳細資訊，請參閱 基本輔助功能資訊。 如需如何測試專案是否已經有對等提供的 名稱 很有用的詳細資訊，請參閱 輔助功能測試。
基於當地語系化原因，您應該避免 XAML 中 名稱 的硬式編碼字串值。 如果您在 元素上設定 x：Uid 指示詞，則可以使用 RESW 資源將屬性設為目標，並提供不同的當地語系化值。 對於附加屬性，資源標識符窗體需要 XAML 窗體中附加屬性的完整限定性，包括其命名空間和 using： 前置詞。 例如，若要以 x：Uid 指示詞 值為 “sendButton” 的資源 AutomationProperties.Name 附加屬性值為目標，RESW 資源中 數據 專案的 名稱 值 sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name
附加屬性
注意
如需每個附加屬性的詳細資訊，請參閱 屬性的 [識別元] 字段頁面。
| 附加屬性 | 描述 |
|---|---|
| AcceleratorKey | 取得或設定指定專案的快速鍵。 |
| AccessibilityView | 取得或設定專案的Microsoft用戶介面自動化樹視圖模式。 |
| AccessKey | 取得或設定指定項目的訪問鍵。 |
| AutomationId | 取得或設定字串，這個字串可唯一識別要Microsoft使用者介面自動化的專案。 |
| 文化 | 取得或設定自動化項目的地區設定標識碼（例如，0x0409 “en-US” 或英文 （美國））。指定之專案的文化特性屬性值。 |
| FullDescription | 取得或設定當地語系化字串，其中包含專案的擴充描述文字。 |
| HeadingLevel | 取得或設定UI自動化專案的標題層級。 |
| HelpText | 取得或設定 項目的說明文字。 |
| IsDataValidForForm | 取得或設定值，這個值表示數據是否對窗體有效。 |
| IsDialog | 取得或設定值，這個值表示自動化專案是否為對話框視窗。 |
| IsPeripheral | 取得或設定值，這個值表示自動化專案是否代表周邊 UI。 |
| IsRequiredForForm | 取得或設定值，這個值表示是否需要在窗體上填寫專案。 |
| ItemStatus | 取得或設定專案中項目狀態的描述。 |
| ItemType | 取得或設定指定專案型別的描述。 |
| LabeledBy | 取得或設定包含專案之文字標籤的專案。 |
| LandmarkType | 取得或設定與專案相關聯的 地標類型標識碼。 |
| 水準 | 取得或設定以 1 為基礎的整數，描述階層式或中斷階層式結構內專案的位置。 |
| LiveSetting | 取得或設定指定項目的即時設定值。 |
| LocalizedControlType | 取得或設定本地化的文字字串，描述自動化專案所代表的控件類型。 |
| LocalizedLandmarkType | 取得或設定本地化的文字字串，描述自動化專案所代表的地標類型。 |
| 名字 | 取得或設定專案的UI自動化名稱。 |
| PositionInSet | 取得或設定以 1 為基底的整數，這個整數描述專案在一組視為同層級的專案中專案的序數位置。 |
| SizeOfSet | 取得或設定一組視為同層級的專案中的項目數目。 |
屬性
| AcceleratorKeyProperty |
識別 AutomationProperties.AcceleratorKey 附加屬性，這是包含自動化專案之快捷鍵（也稱為快捷鍵）組合的字元串。 |
| AccessibilityViewProperty |
識別 AutomationProperties.AccessibilityView 附加屬性。 在個別元素上設定這個附加屬性，以便將其元素可見性變更為UI自動化用戶端要求的特定模式。 |
| AccessKeyProperty |
識別 AutomationProperties.AccessKey 附加屬性，這是包含自動化專案存取索引鍵字元的字串。 |
| AnnotationsProperty |
識別檔中批注物件清單所使用的相依性屬性，例如批注、頁首、頁尾等等。 |
| AutomationControlTypeProperty |
識別 AutomationProperties 附加屬性，這是 Microsoft.UI.Xaml.Automation.Peers.AutomationControlType。 |
| AutomationIdProperty |
識別 AutomationProperties.AutomationId 附加屬性，這是包含自動化專案 UI 自動化標識碼 （ID） 的字元串。 |
| ControlledPeersProperty |
識別 ControlledPeers 附加屬性，這個屬性用於可由指定自動化專案操作的自動化專案集合。 |
| CultureProperty |
取得文化特性附加屬性的標識碼，其中包含自動化專案的地區設定標識碼（例如，0x0409 “en-US” 或英文 （美國） ）。 |
| DescribedByProperty |
取得附加屬性所描述的識別碼，這是項目數位列，可提供自動化專案的詳細資訊。 |
| FlowsFromProperty |
取得 FlowFrom 附加屬性的標識碼，這是自動化元素陣列，會建議目前自動化專案之前的閱讀順序。 |
| FlowsToProperty |
取得 FlowTo 附加屬性的識別碼，這是自動化專案的數位，可建議目前自動化專案之後的閱讀順序。 |
| FullDescriptionProperty |
取得完整描述附加屬性的標識碼，這個屬性會公開包含專案的擴充描述文字的當地語系化字串。 |
| HeadingLevelProperty |
取得 HeadingLevel 附加屬性的標識碼，表示 UI 自動化專案的標題層級。 |
| HelpTextProperty |
識別 AutomationProperties.HelpText 附加屬性，這是與自動化專案相關聯的說明文字字串。 |
| IsDataValidForFormProperty |
識別布爾相依性屬性，指出數據是否對窗體有效。 |
| IsDialogProperty |
識別 AutomationProperties.IsDialog 附加屬性，這是布爾值，指出自動化專案是否為對話框視窗。 |
| IsPeripheralProperty |
識別布爾相依性屬性，指出自動化專案是否代表周邊 UI。 |
| IsRequiredForFormProperty |
識別 AutomationProperties.IsRequiredForForm 附加屬性，這是布爾值，指出是否需要在表單上填寫自動化專案。 |
| ItemStatusProperty |
識別 ItemStatus 附加屬性，這個屬性描述自動化項目項目的狀態。 |
| ItemTypeProperty |
識別 AutomationProperties.ItemType 附加屬性，這是描述自動化專案類型的文字字串。 |
| LabeledByProperty |
識別 AutomationProperties.LabeledBy 附加屬性，這是包含這個專案文字標籤的自動化專案。 |
| LandmarkTypeProperty |
取得地標類型附加屬性的標識碼，這是與專案相關聯的 地標類型標識碼。 |
| LevelProperty |
取得 Level 附加屬性的標識碼，這是與自動化專案相關聯的 1 型整數。 |
| LiveSettingProperty |
識別 AutomationProperties.LiveSetting 附加屬性，這個屬性是由代表即時區域的自動化專案所支援。 |
| LocalizedControlTypeProperty |
識別本地化的控件類型相依性屬性，這是描述自動化專案所代表控件類型的文字字串。 |
| LocalizedLandmarkTypeProperty |
取得當地語系化地標類型附加屬性的標識碼，這是當地語系化文字字串，描述自動化專案所代表的地標類型。 |
| NameProperty |
識別附加屬性 AutomationProperties.Name，這是保存自動化專案名稱的字串。 |
| PositionInSetProperty |
取得 PositionInSet 附加屬性的標識碼，這是與自動化專案相關聯的 1 型整數。 |
| SizeOfSetProperty |
取得附加屬性的標識碼。 |
附加屬性
| AcceleratorKey |
取得或設定字串，其中包含自動化專案的快捷鍵（也稱為快捷鍵）組合。 |
| AccessibilityView |
取得或設定專案的Microsoft用戶介面自動化樹視圖模式。 |
| AccessKey |
取得或設定字串，其中包含自動化專案的存取索引鍵字元。 |
| Annotations |
取得檔中的批注物件清單，例如批注、頁首、頁尾等等。 |
| AutomationControlType |
識別公開給 Microsoft UI 自動化用戶端的使用者介面 （UI） 項目類型。 |
| AutomationId |
取得或設定字串，這個字串可唯一識別要Microsoft使用者介面自動化的專案。 |
| ControlledPeers |
取得可由指定自動化專案操作的自動化專案集合。 |
| Culture |
取得或設定自動化項目的地區設定標識碼（例如，0x0409 “en-US” 或英文 （美國））。 |
| DescribedBy |
取得項目數位，提供自動化專案的詳細資訊。 |
| FlowsFrom |
取得自動化項目的陣列，這個數位會建議目前自動化專案之前的閱讀順序。 |
| FlowsTo |
取得自動化項目的陣列，這個陣列會建議目前自動化專案之後的讀取順序。 |
| FullDescription |
取得或設定當地語系化字串，其中包含專案的擴充描述文字。 |
| HeadingLevel |
取得或設定UI自動化專案的標題層級。 |
| HelpText |
取得或設定與自動化項目相關聯的說明文字字串。 |
| IsDataValidForForm |
取得或設定值，這個值表示數據是否對窗體有效。 |
| IsDialog |
取得或設定值，這個值表示自動化專案是否為對話框視窗。 |
| IsPeripheral |
取得或設定值，這個值表示自動化專案是否代表周邊 UI。 |
| IsRequiredForForm |
取得或設定值，這個值表示是否需要在窗體上填寫專案。 |
| ItemStatus |
取得或設定專案中項目狀態的描述。 |
| ItemType |
取得或設定指定專案型別的描述。 |
| LabeledBy |
取得或設定自動化專案，其中包含這個專案的文字標籤。 |
| LandmarkType |
取得或設定與專案相關聯的 地標類型標識碼。 |
| Level |
取得或設定以 1 為基礎的整數，描述階層式或中斷階層式結構內專案的位置。 |
| LiveSetting |
取得或設定所指定專案的即時設定值，這個值是由表示即時區域的自動化專案所支援。 |
| LocalizedControlType |
取得或設定本地化的文字字串，描述自動化專案所代表的控件類型。 |
| LocalizedLandmarkType |
取得或設定本地化的文字字串，描述自動化專案所代表的地標類型。 |
| Name |
取得或設定專案的UI自動化名稱。 |
| PositionInSet |
取得或設定以 1 為基底的整數，這個整數描述專案在一組視為同層級的專案中專案的序數位置。 |
| SizeOfSet |
取得或設定一組視為同層級的專案中的項目數目。 |