IValueProvider interface

Applies to Windows and Windows Phone

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that have an intrinsic value that does not span a range and that can be represented as a string. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Value.

Syntax


Public Interface IValueProvider

Attributes

[Version(0x06020000)]
[WebHostHidden()]

Members

The IValueProvider interface has these types of members:

Methods

The IValueProvider interface has these methods. It also inherits methods from the Object class.

MethodDescription
SetValue Sets the value of a control.

 

Properties

The IValueProvider interface has these properties.

PropertyAccess typeDescription

IsReadOnly

Read-onlyGets a value that indicates whether the value of a control is read-only.

Value

Read-onlyGets the value of the control.

 

Remarks

The value string can be editable, depending on the control and its settings. This pattern has guidelines and conventions that aren't fully documented here. For more info on what this pattern is for, see Value Control Pattern.

IValueProvider is implemented by the existing Windows Runtime class ComboBoxAutomationPeer.

The text models supported by Windows Runtime text controls such as TextBox and RichTextBlock don't use the IValueProvider pattern.

Use ValuePatternIdentifiers if you want to reference the IValueProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent.

Requirements

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.Provider
Windows::UI::Xaml::Automation::Provider [C++]

Metadata

Windows.winmd

See also

ValuePatternIdentifiers
IValueProvider (COM interface)
Custom automation peers
Value Control Pattern

 

 

Show:
© 2014 Microsoft