IRangeValueProvider IRangeValueProvider IRangeValueProvider Interface

Exposes methods and properties to support access by a Microsoft UI Automation client to controls that can be set to a value within a range. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern(Windows.UI.Xaml.Automation.Peers.PatternInterface) call and PatternInterface.

Syntax

Declaration

public interface IRangeValueProviderpublic interface IRangeValueProviderPublic Interface IRangeValueProvider

Remarks

This pattern has guidelines and conventions that aren't fully documented here. For more info on what this pattern is for, see RangeValue Control Pattern.

IRangeValueProvider is implemented by the existing Windows Runtime class RangeBaseAutomationPeer. This is the base class for peers for Slider, ScrollBar and ProgressBar. ProgressBarAutomationPeer adds an override such that it won't support the pattern if the value of IsIndeterminate on the owner control is false.

Use RangeValuePatternIdentifiers if you want to reference the IRangeValueProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent(Windows.UI.Xaml.Automation.AutomationProperty,System.Object,System.Object).

Properties summary

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

Gets the value that is added to or subtracted from the Value property when a large change is made, such as with the PAGE DOWN key.

Gets the maximum range value that is supported by the control.

Gets the minimum range value that is supported by the control.

Gets the value that is added to or subtracted from the Value property when a small change is made, such as with an arrow key.

Gets the value of the control.

Methods summary

Sets the value of the control.

Properties

  • IsReadOnly
    IsReadOnly
    IsReadOnly
    IsReadOnly

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

    public bool IsReadOnly { get; }public bool IsReadOnly { get; }Public ReadOnly Property IsReadOnly As bool

    Property Value

    • bool
      bool
      bool

      true if the value is read-only; false if it can be modified.

  • LargeChange
    LargeChange
    LargeChange
    LargeChange

    Gets the value that is added to or subtracted from the Value property when a large change is made, such as with the PAGE DOWN key.

    public double LargeChange { get; }public double LargeChange { get; }Public ReadOnly Property LargeChange As double

    Property Value

    • double
      double
      double

      The large-change value that is supported by the control, or null if the control does not support LargeChange.

  • Maximum
    Maximum
    Maximum
    Maximum

    Gets the maximum range value that is supported by the control.

    public double Maximum { get; }public double Maximum { get; }Public ReadOnly Property Maximum As double

    Property Value

    • double
      double
      double

      The maximum value that is supported by the control, or null if the control does not support Maximum.

  • Minimum
    Minimum
    Minimum
    Minimum

    Gets the minimum range value that is supported by the control.

    public double Minimum { get; }public double Minimum { get; }Public ReadOnly Property Minimum As double

    Property Value

    • double
      double
      double

      The minimum value that is supported by the control, or null if the control does not support Minimum.

  • SmallChange
    SmallChange
    SmallChange
    SmallChange

    Gets the value that is added to or subtracted from the Value property when a small change is made, such as with an arrow key.

    public double SmallChange { get; }public double SmallChange { get; }Public ReadOnly Property SmallChange As double

    Property Value

    • double
      double
      double

      The small-change value supported by the control, or null if the control does not support SmallChange.

  • Value
    Value
    Value
    Value

    Gets the value of the control.

    public double Value { get; }public double Value { get; }Public ReadOnly Property Value As double

    Property Value

    • double
      double
      double

      The value of the control, or null if the control does not support Value.

Methods

  • SetValue(System.Double)
    SetValue(System.Double)
    SetValue(System.Double)
    SetValue(System.Double)

    Sets the value of the control.

    public void SetValue(System.Double value)public void SetValue(System.Double value)Public Function SetValue(value As System.Double) As void

    Parameters

    • value
      System.Double
      System.Double
      System.Double

      The value to set.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.GuidAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute
Windows.Foundation.Metadata.ContractVersionAttribute

Details

Assembly

Windows.UI.Xaml.Automation.Provider.dll