Windows Dev Center

Expand Minimize

AutomationPeer.IsRequiredForFormCore method

Provides the peer's behavior when a Microsoft UI Automation client calls IsRequiredForForm or an equivalent UI Automation client API.

Syntax


protected virtual bool IsRequiredForFormCore()

Parameters

This method has no parameters.

Return value

Type: System.Boolean [.NET] | Platform::Boolean [C++]

true if the element must be completed; otherwise, false.

Remarks

The "Core" methods are the standard implementations that perform the default action of an associated UI Automation client-callable method. You can override any of the "Core" methods to return alternative values in a custom automation peer. In this case, IsRequiredForFormCore is invoked any time that IsRequiredForForm is called.

The standard implementation returns false. Overriding this value at the peer level to return true is probably an uncommon scenario, because you are implying that every instance of your control has a required-for-form behavior no matter what app or UI situation it is used for. It's more typical for apps to specify a required-for-form behavior that is declared in the app's XAML UI definitions, by setting AutomationProperties.IsRequiredForForm.

Requirements (Windows 10 device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.Xaml.Automation.Peers
Windows::UI::Xaml::Automation::Peers [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Automation.Peers
Windows::UI::Xaml::Automation::Peers [C++]

Metadata

Windows.winmd

See also

AutomationPeer
FrameworkElementAutomationPeer
Custom automation peers
Accessibility for Windows Store apps using C#/VB/C++ and XAML

 

 

Show:
© 2015 Microsoft