IValueProvider
IValueProvider
IValueProvider
IValueProvider
Interface
Definition
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.
public : interface IValueProviderpublic interface IValueProviderPublic Interface IValueProvider// This API is not available in Javascript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
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.
Properties
IsReadOnly IsReadOnly IsReadOnly IsReadOnly
Gets a value that indicates whether the value of a control is read-only.
public : PlatForm::Boolean IsReadOnly { get; }public bool IsReadOnly { get; }Public ReadOnly Property IsReadOnly As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the value is read-only; false if it can be modified.
Methods
SetValue(String) SetValue(String) SetValue(String) SetValue(String)
Sets the value of a control.
public : void SetValue(PlatForm::String value)public void SetValue(String value)Public Function SetValue(value As String) As void// This API is not available in Javascript.
- value
- PlatForm::String String String String
The value to set. The provider is responsible for converting the value to the appropriate data type.