AutomationProperties 類別
定義
重要
部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。
提供取得或設定自動化屬性實例層級值的支援。 這些屬性值會設定為附加屬性， (通常是在 XAML) 中，並從控制項的 AutomationPeer補充或覆寫自動化屬性值。
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 附加屬性的主機服務類別。 這些附加屬性的目的是要啟用各種個別實例值，這些值與如何向 Microsoft UI 自動化協助工具架構報告 UI 元素有關。 如果 UI 元素的類別設計尚未轉送其他 UI 相關屬性值做為其 Microsoft UI 自動化整合或對等實作行為的一部分，或轉送的值不是您想要向 Microsoft UI 自動化報告的值，則這非常有用。
為了支援 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類別的對等轉送會轉送Button內容的ToString評估，並使用此字串作為預設的 Name。 若要覆寫該預設值，或為沒有可用 Microsoft UI 自動化名稱的任何 UI 元素案例提供Name值，請在 XAML 中設定該元素的Name附加屬性。 如需 Microsoft UI 自動化 名稱 為何很重要的詳細資訊，請參閱 基本協助工具資訊。 如需如何測試專案是否已經有對等提供 名稱 且很有用的詳細資訊，請參閱 輔助功能測試。
基於當地語系化理由，您應該避免 XAML 中 Name 的硬式編碼字串值。 如果您在 元素上設定 x：Uid 指示詞 ，則可以使用 RESW 資源來以 屬性為目標，並提供不同的當地語系化值。 對於附加屬性，資源識別碼表單需要 XAML 表單中附加屬性的完整限定性，包括其命名空間和 using： 前置詞。 例如，若要在具有 「sendButton」 x：Uid 指示詞值的資源上，以 AutomationProperties.Name附加屬性值為目標，RESW 資源中的資料項目名稱值是sendButton.[using:Windows.UI.Xaml.Automation]AutomationProperties.Name
附加屬性
注意
如需每個附加屬性的詳細資訊，請參閱屬性的 [識別碼] 欄位頁面。
| 附加屬性 | 描述 |
|---|---|
| AcceleratorKey | 取得或設定指定元素的快速鍵。 |
| AccessibilityView | 取得或設定專案的 Microsoft UI 自動化樹狀檢視模式。 |
| AccessKey | 取得或設定指定元素的存取金鑰。 |
| AutomationId | 取得或設定可唯一識別專案給 Microsoft UI 自動化的字串。 |
| 文化特性 | 取得或設定自動化專案的地區設定識別碼 (，例如，0x0409 「en-US」 或 English (美國) ) 。指定專案之文化特性屬性的值。 |
| FullDescription | 取得或設定當地語系化字串，其中包含專案的擴充描述文字。 |
| HeadingLevel | 取得或設定使用者介面自動化專案的標題層級。 |
| HelpText | 取得或設定 專案的解說文字。 |
| IsDataValidForForm | 取得或設定值，這個值表示資料是否對表單有效。 |
| IsDialog | 取得或設定值，這個值表示自動化專案是否為對話方塊視窗。 |
| IsPeripheral | 取得或設定值，這個值表示自動化專案是否代表周邊 UI。 |
| IsRequiredForForm | 取得或設定值，這個值表示是否需要在表單上填寫專案。 |
| ItemStatus | 取得或設定專案中專案狀態的描述。 |
| ItemType | 取得或設定指定之項目型別的描述。 |
| LabeledBy | 取得或設定包含專案之文字標籤的專案。 |
| LandmarkType | 取得或設定與專案相關聯的 地標類型識別碼 。 |
| 層級 | 取得或設定以 1 為基礎的整數，描述階層式或中斷階層式結構內元素的位置。 |
| LiveSetting | 取得或設定指定專案的即時設定值。 |
| LocalizedControlType | 取得或設定當地語系化的文字字串，描述自動化專案所代表的控制項類型。 |
| LocalizedLandmarkType | 取得或設定當地語系化的文字字串，描述自動化專案所代表的地標類型。 |
| 名稱 | 取得或設定專案的 UI 自動化名稱。 |
| PositionInSet | 取得或設定一個以 1 為基礎的整數，描述一組視為同層級之元素內的元素序數位置。 |
| SizeOfSet | 取得或設定一組視為同層級的專案中的專案數目。 |
屬性
| AcceleratorKeyProperty |
識別 AutomationProperties.AcceleratorKey 附加屬性，這是字串，其中包含快速鍵 (也稱為自動化元素的快速鍵) 組合。 |
| AccessibilityViewProperty |
識別 AutomationProperties.AccessibilityView 附加屬性。 在個別元素上設定這個附加屬性，以將其元素可見度變更為使用者介面自動化用戶端所要求的特定模式。 |
| AccessKeyProperty |
識別 AutomationProperties.AccessKey 附加屬性，這是包含自動化專案存取索引鍵字元的字串。 |
| AnnotationsProperty |
識別用於檔中批註物件清單的相依性屬性，例如批註、頁首、頁尾等等。 |
| AutomationControlTypeProperty |
AutomationProperties識別附加屬性，也就是 Microsoft.UI.Xaml.Automation.Peers.AutomationControlType 。 |
| AutomationIdProperty |
識別 AutomationProperties.AutomationId 附加屬性，這是字串，其中包含自動化專案的 UI 自動化識別碼 (識別碼) 。 |
| 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 UI 自動化樹狀檢視模式。 |
| AccessKey |
取得或設定字串，其中包含自動化專案的存取索引鍵字元。 |
| Annotations |
取得檔中的批註物件清單，例如批註、頁首、頁尾等等。 |
| AutomationControlType |
識別公開給 Microsoft UI 自動化用戶端的使用者介面類別型 (UI) 元素。 |
| AutomationId |
取得或設定可唯一識別專案給 Microsoft UI 自動化的字串。 |
| 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 |
取得或設定一組被視為同層級的專案中的專案數目。 |
方法
適用於
另請參閱
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應