Package at.bestsolution.uia

Interface IStylesProvider

All Superinterfaces:
IInitable
public interface IStylesProvider extends IInitable
Provides access to the visual styles associated with the content of a document.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    IStylesProvider.StylesProviderContext
    context object for IStylesProvider.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    get_ExtendedProperties()
    Contains additional properties that are not included in this control pattern, but that provide information about the document content that might be useful to the user.
    Color
    get_FillColor()
    Specifies the fill color of an element in a document.
    Color
    get_FillPatternColor()
    Specifies the color of the pattern used to fill an element in a document.
    String
    get_FillPatternStyle()
    Specifies the fill pattern style of an element in a document.
    String
    get_Shape()
    Specifies the shape of an element in a document.
    int
    get_StyleId()
    Identifies the visual style of an element in a document.
    String
    get_StyleName()
    Specifies the name of the visual style of an element in a document.

    Methods inherited from interface at.bestsolution.uia.IInitable

    initialize

  • Method Details

    • get_ExtendedProperties

      String get_ExtendedProperties()
      Contains additional properties that are not included in this control pattern, but that provide information about the document content that might be useful to the user.

      The extended properties must be localized because they are intended to be consumed by the user.

      Returns:
      the extended properties

    • get_FillColor

      Color get_FillColor()
      Specifies the fill color of an element in a document.
      Returns:
      the fill color

    • get_FillPatternColor

      Color get_FillPatternColor()
      Specifies the color of the pattern used to fill an element in a document.
      Returns:
      the fill pattern color

    • get_FillPatternStyle

      String get_FillPatternStyle()
      Specifies the fill pattern style of an element in a document.
      Returns:
      the fill pattern style

    • get_Shape

      String get_Shape()
      Specifies the shape of an element in a document.
      Returns:
      the shape

    • get_StyleId

      int get_StyleId()
      Identifies the visual style of an element in a document.

      A provider should use this property to expose style identifiers that are useful to client applications. For example, a provider might expose the StyleId_Title identifier for an element that represents the title of a presentation. A screen reader could then retrieve the StyleId property, discover that the element is a presentation title, and read the title to the user.

      List Styles IDs for list styles are supported starting with Windows 8.1. These styles should be applied at a paragraph level; all text that is part of a list item should have one of these styles applied to it. When bullet styles are mixed within a list, the BulletedList style should be applied to the whole range, and the BulletStyle attribute value (property identified by UIA_BulletStyleAttributeId) should be mixed according to breakdown of different bullet types within the range. When nested lists contain bullets also (perhaps of a different type than the main list), the BulletedList style would again be applied to the whole range, and the BulletStyle attribute value is whatever the nested bullet style is (for the range covering the nested list).

      Returns:
      the style id

    • get_StyleName

      String get_StyleName()
      Specifies the name of the visual style of an element in a document.

      The style name typically indicates the role of the element in the document, such as "Heading 1."

      Returns:
      the style name