Package at.bestsolution.uia

Interface IValueProvider

All Superinterfaces:
IInitable
public interface IValueProvider extends IInitable
Provides access to controls that have an intrinsic value that does not span a range, and that can be represented as a string.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    IValueProvider.ValueProviderContext
    context object for IValueProvider.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    get_IsReadOnly()
    Indicates whether the value of a control is read-only.
    String
    get_Value()
    The value of the control.
    void
    SetValue(String value)
    Sets the value of control.

    Methods inherited from interface at.bestsolution.uia.IInitable

    initialize

  • Method Details

    • get_IsReadOnly

      boolean get_IsReadOnly()
      Indicates whether the value of a control is read-only.

      A control should have its IsEnabled property (UIA_IsEnabledPropertyId) set to TRUE and its IValueProvider::IsReadOnly property set to FALSE before allowing a call to IValueProvider::SetValue.

      Returns:
      true if readonly

    • get_Value

      String get_Value()
      The value of the control.

      Single-line edit controls support programmatic access to their contents by implementing IValueProvider (in addition to ITextProvider). However, multi-line edit controls do not implement IValueProvider. To retrieve the textual contents of multi-line edit controls, the controls must implement ITextProvider. However, ITextProvider does not support setting the value of a control. IValueProvider does not support the retrieval of formatting information or substring values. Implement ITextProvider in these scenarios.

      Returns:
      the value

    • SetValue

      void SetValue(String value)
      Sets the value of control.

      Single-line edit controls support programmatic access to their contents by implementing IValueProvider. However, multi-line edit controls do not implement IValueProvider; instead they provide access to their content by implementing ITextProvider. Controls such as ListItem and TreeItem must implement IValueProvider if the value of any of the items is editable, regardless of the current edit mode of the control. The parent control must also implement IValueProvider if the child items are editable.

      Parameters:
      value - the value