Package at.bestsolution.uia

Enum Class StandardTextAttributeIds

java.lang.Object

java.lang.Enum<StandardTextAttributeIds>

at.bestsolution.uia.StandardTextAttributeIds

All Implemented Interfaces:

INativeConstant, INativeEnum, ITextAttributeId, Serializable, Comparable<StandardTextAttributeIds>, Constable

public enum StandardTextAttributeIds
extends Enum<StandardTextAttributeIds>
implements ITextAttributeId, INativeEnum

This topic describes the named constants used to identify text attributes of a Microsoft UI Automation text range. These constants are used with the following methods:

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
UIA_AfterParagraphSpacingAttributeId	Identifies the AfterParagraphSpacing text attribute, which specifies the size of spacing after the paragraph.
UIA_AnimationStyleAttributeId	Identifies the AnimationStyle text attribute, which specifies the type of animation applied to the text.
UIA_AnnotationObjectsAttributeId	Identifies the AnnotationObjects text attribute, which maintains an array of IUIAutomationElement2 interfaces, one for each element in the current text range that implements the Annotation control pattern.
UIA_AnnotationTypesAttributeId	Identifies the AnnotationTypes text attribute, which maintains a list of annotation type identifiers for a range of text.
UIA_BackgroundColorAttributeId	Identifies the BackgroundColor text attribute, which specifies the background color of the text.
UIA_BeforeParagraphSpacingAttributeId	Identifies the BeforeParagraphSpacing text attribute, which specifies the size of spacing before the paragraph.
UIA_BulletStyleAttributeId	Identifies the BulletStyle text attribute, which specifies the style of bullets used in the text range.
UIA_CapStyleAttributeId	Identifies the CapStyle text attribute, which specifies the capitalization style for the text.
UIA_CaretBidiModeAttributeId	Identifies the CaretBidiMode text attribute, which indicates the direction of text flow in the text range.
UIA_CaretPositionAttributeId	Identifies the CaretPosition text attribute, which indicates whether the caret is at the beginning or the end of a line of text in the text range.
UIA_CultureAttributeId	Identifies the Culture text attribute, which specifies the locale of the text by locale identifier (LCID).
UIA_FontNameAttributeId	Identifies the FontName text attribute, which specifies the name of the font.
UIA_FontSizeAttributeId	Identifies the FontSize text attribute, which specifies the point size of the font.
UIA_FontWeightAttributeId	Identifies the FontWeight text attribute, which specifies the relative stroke, thickness, or boldness of the font.
UIA_ForegroundColorAttributeId	Identifies the ForegroundColor text attribute, which specifies the foreground color of the text.
UIA_HorizontalTextAlignmentAttributeId	Identifies the HorizontalTextAlignment text attribute, which specifies how the text is aligned horizontally.
UIA_IndentationFirstLineAttributeId	Identifies the IndentationFirstLine text attribute, which specifies how far, in points, to indent the first line of a paragraph.
UIA_IndentationLeadingAttributeId	Identifies the IndentationLeading text attribute, which specifies the leading indentation, in points.
UIA_IndentationTrailingAttributeId	Identifies the IndentationTrailing text attribute, which specifies the trailing indentation, in points.
UIA_IsActiveAttributeId	Identifies the IsActive text attribute, which indicates whether the control that contains the text range has the keyboard focus (TRUE) or not (FALSE).
UIA_IsHiddenAttributeId	Identifies the IsHidden text attribute, which indicates whether the text is hidden (TRUE) or visible (FALSE).
UIA_IsItalicAttributeId	Identifies the IsItalic text attribute, which indicates whether the text is italic (TRUE) or not (FALSE).
UIA_IsReadOnlyAttributeId	Identifies the IsReadOnly text attribute, which indicates whether the text is read-only (TRUE) or can be modified (FALSE).
UIA_IsSubscriptAttributeId	Identifies the IsSubscript text attribute, which indicates whether the text is subscript (TRUE) or not (FALSE).
UIA_IsSuperscriptAttributeId	Identifies the IsSuperscript text attribute, which indicates whether the text is subscript (TRUE) or not (FALSE).
UIA_LineSpacingAttributeId	Identifies the LineSpacing text attribute, which specifies the spacing between lines of text.
UIA_LinkAttributeId	Identifies the Link text attribute, which contains the IUIAutomationTextRange interface of the text range that is the target of an internal link in a document.
UIA_MarginBottomAttributeId	Identifies the MarginBottom text attribute, which specifies the size, in points, of the bottom margin applied to the page associated with the text range.
UIA_MarginLeadingAttributeId	Identifies the MarginLeading text attribute, which specifies the size, in points, of the leading margin applied to the page associated with the text range.
UIA_MarginTopAttributeId	Identifies the MarginTop text attribute, which specifies the size, in points, of the top margin applied to the page associated with the text range.
UIA_MarginTrailingAttributeId	Identifies the MarginTrailing text attribute, which specifies the size, in points, of the trailing margin applied to the page associated with the text range.
UIA_OutlineStylesAttributeId	Identifies the OutlineStyles text attribute, which specifies the outline style of the text.
UIA_OverlineColorAttributeId	Identifies the OverlineColor text attribute, which specifies the color of the overline text decoration.
UIA_OverlineStyleAttributeId	Identifies the OverlineStyle text attribute, which specifies the style of the overline text decoration.
UIA_SayAsInterpretAsAttributeId	not documented
UIA_SelectionActiveEndAttributeId	Identifies the SelectionActiveEnd text attribute, which indicates the location of the caret relative to a text range that represents the currently selected text.
UIA_StrikethroughColorAttributeId	Identifies the StrikethroughColor text attribute, which specifies the color of the strikethrough text decoration.
UIA_StrikethroughStyleAttributeId	Identifies the StrikethroughStyle text attribute, which specifies the style of the strikethrough text decoration.
UIA_StyleIdAttributeId	Identifies the StyleId text attribute, which indicates the text styles in use for a text range.
UIA_StyleNameAttributeId	Identifies the StyleName text attribute, which identifies the localized name of the text style in use for a text range.
UIA_TabsAttributeId	Identifies the Tabs text attribute, which is an array specifying the tab stops for the text range.
UIA_TextFlowDirectionsAttributeId	Identifies the TextFlowDirections text attribute, which specifies the direction of text flow.
UIA_UnderlineColorAttributeId	Identifies the UnderlineColor text attribute, which specifies the color of the underline text decoration.
UIA_UnderlineStyleAttributeId	Identifies the UnderlineStyle text attribute, which specifies the style of the underline text decoration.

Method Summary

Modifier and Type	Method	Description
static Optional<StandardTextAttributeIds>	fromNativeValue(int nativeValue)
String	getConstantName()
int	getNativeValue()
static StandardTextAttributeIds	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StandardTextAttributeIds[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UIA_AfterParagraphSpacingAttributeId

public static final StandardTextAttributeIds UIA_AfterParagraphSpacingAttributeId

Identifies the AfterParagraphSpacing text attribute, which specifies the size of spacing after the paragraph. Variant type: VT_R8 Default value: 0

UIA_AnimationStyleAttributeId

public static final StandardTextAttributeIds UIA_AnimationStyleAttributeId

Identifies the AnimationStyle text attribute, which specifies the type of animation applied to the text. This attribute is specified as a value from the AnimationStyle enumerated type. Variant type: VT_I4 Default value: AnimationStyle_None

UIA_AnnotationObjectsAttributeId

public static final StandardTextAttributeIds UIA_AnnotationObjectsAttributeId

Identifies the AnnotationObjects text attribute, which maintains an array of IUIAutomationElement2 interfaces, one for each element in the current text range that implements the Annotation control pattern. Each element might also implement other control patterns as needed to describe the annotation. For example, an annotation that is a comment would also support the Text control pattern. Supported starting with Windows 8. Variant type: VT_UNKNOWN Default value: empty array

UIA_AnnotationTypesAttributeId

public static final StandardTextAttributeIds UIA_AnnotationTypesAttributeId

Identifies the AnnotationTypes text attribute, which maintains a list of annotation type identifiers for a range of text. For a list of possible values, see Annotation Type Identifiers. Supported starting with Windows 8. Variant type: VT_ARRAY | VT_I4 Default value: empty array

UIA_BackgroundColorAttributeId

public static final StandardTextAttributeIds UIA_BackgroundColorAttributeId

Identifies the BackgroundColor text attribute, which specifies the background color of the text. This attribute is specified as a COLORREF; a 32-bit value used to specify an RGB or RGBA color. Variant type: VT_I4 Default value: 0

UIA_BeforeParagraphSpacingAttributeId

public static final StandardTextAttributeIds UIA_BeforeParagraphSpacingAttributeId

Identifies the BeforeParagraphSpacing text attribute, which specifies the size of spacing before the paragraph. Variant type: VT_R8 Default value: 0

UIA_BulletStyleAttributeId

public static final StandardTextAttributeIds UIA_BulletStyleAttributeId

Identifies the BulletStyle text attribute, which specifies the style of bullets used in the text range. This attribute is specified as a value from the BulletStyle enumerated type. Variant type: VT_I4 Default value: BulletStyle_None

UIA_CaretBidiModeAttributeId

public static final StandardTextAttributeIds UIA_CaretBidiModeAttributeId

Identifies the CaretBidiMode text attribute, which indicates the direction of text flow in the text range. This attribute is specified as a value from the CaretBidiMode enumerated type. Supported starting with Windows 8. Variant type: VT_I4 Default value: CaretBidiMode_LTR

UIA_CaretPositionAttributeId

public static final StandardTextAttributeIds UIA_CaretPositionAttributeId

Identifies the CaretPosition text attribute, which indicates whether the caret is at the beginning or the end of a line of text in the text range. This attribute is specified as a value from the CaretPosition enumerated type. Supported starting with Windows 8. Variant type: VT_I4 Default value: CaretPosition_Unknown

UIA_CultureAttributeId

public static final StandardTextAttributeIds UIA_CultureAttributeId

Identifies the Culture text attribute, which specifies the locale of the text by locale identifier (LCID). Variant type: VT_I4 Default value: locale of the application UI

UIA_FontNameAttributeId

public static final StandardTextAttributeIds UIA_FontNameAttributeId

Identifies the FontName text attribute, which specifies the name of the font. Examples: "Arial Black"; "Arial Narrow". The font name string is not localized. Variant type: VT_BSTR Default value: empty string

UIA_FontSizeAttributeId

public static final StandardTextAttributeIds UIA_FontSizeAttributeId

Identifies the FontSize text attribute, which specifies the point size of the font. Variant type: VT_R8 Default value: 0

UIA_FontWeightAttributeId

public static final StandardTextAttributeIds UIA_FontWeightAttributeId

Identifies the FontWeight text attribute, which specifies the relative stroke, thickness, or boldness of the font. The FontWeight attribute is modeled after the lfWeight member of the GDI LOGFONT structure, and related standards, and can be one of the following values:

• 0 = DontCare
• 100 = Thin
• 200 = ExtraLight or UltraLight
• 300 = Light
• 400 = Normal or Regular
• 500 = Medium
• 600 = SemiBold
• 700 = Bold
• 800 = ExtraBold or UltraBold
• 900 = Heavy or Black

Variant type: VT_I4 Default value: 0

UIA_ForegroundColorAttributeId

public static final StandardTextAttributeIds UIA_ForegroundColorAttributeId

Identifies the ForegroundColor text attribute, which specifies the foreground color of the text. This attribute is specified as a COLORREF, a 32-bit value used to specify an RGB or RGBA color. Variant type: VT_I4 Default value: 0

UIA_HorizontalTextAlignmentAttributeId

public static final StandardTextAttributeIds UIA_HorizontalTextAlignmentAttributeId

Identifies the HorizontalTextAlignment text attribute, which specifies how the text is aligned horizontally. This attribute is specified as a value from the HorizontalTextAlignmentEnum enumerated type. Variant type: VT_I4 Default value: HorizontalTextAlignment_Left

UIA_IndentationFirstLineAttributeId

public static final StandardTextAttributeIds UIA_IndentationFirstLineAttributeId

Identifies the IndentationFirstLine text attribute, which specifies how far, in points, to indent the first line of a paragraph. Variant type: VT_R8 Default value: 0

UIA_IndentationLeadingAttributeId

public static final StandardTextAttributeIds UIA_IndentationLeadingAttributeId

Identifies the IndentationLeading text attribute, which specifies the leading indentation, in points. Variant type: VT_R8 Default value: 0

UIA_IndentationTrailingAttributeId

public static final StandardTextAttributeIds UIA_IndentationTrailingAttributeId

Identifies the IndentationTrailing text attribute, which specifies the trailing indentation, in points. Variant type: VT_R8 Default value: 0

UIA_IsActiveAttributeId

public static final StandardTextAttributeIds UIA_IsActiveAttributeId

Identifies the IsActive text attribute, which indicates whether the control that contains the text range has the keyboard focus (TRUE) or not (FALSE). Supported starting with Windows 8. Variant type: VT_BOOL Default value: FALSE

UIA_IsHiddenAttributeId

public static final StandardTextAttributeIds UIA_IsHiddenAttributeId

Identifies the IsHidden text attribute, which indicates whether the text is hidden (TRUE) or visible (FALSE). Variant type: VT_BOOL Default value: FALSE

UIA_IsItalicAttributeId

public static final StandardTextAttributeIds UIA_IsItalicAttributeId

Identifies the IsItalic text attribute, which indicates whether the text is italic (TRUE) or not (FALSE). Variant type: VT_BOOL Default value: FALSE

UIA_IsReadOnlyAttributeId

public static final StandardTextAttributeIds UIA_IsReadOnlyAttributeId

Identifies the IsReadOnly text attribute, which indicates whether the text is read-only (TRUE) or can be modified (FALSE). Variant type: VT_BOOL Default value: FALSE

UIA_IsSubscriptAttributeId

public static final StandardTextAttributeIds UIA_IsSubscriptAttributeId

Identifies the IsSubscript text attribute, which indicates whether the text is subscript (TRUE) or not (FALSE). Variant type: VT_BOOL Default value: FALSE

UIA_IsSuperscriptAttributeId

public static final StandardTextAttributeIds UIA_IsSuperscriptAttributeId

Identifies the IsSuperscript text attribute, which indicates whether the text is subscript (TRUE) or not (FALSE). Variant type: VT_BOOL Default value: FALSE

UIA_LineSpacingAttributeId

public static final StandardTextAttributeIds UIA_LineSpacingAttributeId

Identifies the LineSpacing text attribute, which specifies the spacing between lines of text. Variant type: VT_BSTR Default value: "LineSpacingAttributeDefault"

UIA_LinkAttributeId

public static final StandardTextAttributeIds UIA_LinkAttributeId

Identifies the Link text attribute, which contains the IUIAutomationTextRange interface of the text range that is the target of an internal link in a document. Supported starting with Windows 8. Variant type: VT_UNKNOWN Default value: NULL

UIA_MarginBottomAttributeId

public static final StandardTextAttributeIds UIA_MarginBottomAttributeId

Identifies the MarginBottom text attribute, which specifies the size, in points, of the bottom margin applied to the page associated with the text range. Variant type: VT_R8 Default value: 0

UIA_MarginLeadingAttributeId

public static final StandardTextAttributeIds UIA_MarginLeadingAttributeId

Identifies the MarginLeading text attribute, which specifies the size, in points, of the leading margin applied to the page associated with the text range. Variant type: VT_R8 Default value: 0

UIA_MarginTopAttributeId

public static final StandardTextAttributeIds UIA_MarginTopAttributeId

Identifies the MarginTop text attribute, which specifies the size, in points, of the top margin applied to the page associated with the text range. Variant type: VT_R8 Ddefault value: 0

UIA_MarginTrailingAttributeId

public static final StandardTextAttributeIds UIA_MarginTrailingAttributeId

Identifies the MarginTrailing text attribute, which specifies the size, in points, of the trailing margin applied to the page associated with the text range. Variant type: VT_R8 Default value: 0

UIA_OutlineStylesAttributeId

public static final StandardTextAttributeIds UIA_OutlineStylesAttributeId

Identifies the OutlineStyles text attribute, which specifies the outline style of the text. This attribute is specified as a value from the OutlineStyles enumerated type. Variant type: VT_I4 Default value: OutlineStyles_None

UIA_OverlineColorAttributeId

public static final StandardTextAttributeIds UIA_OverlineColorAttributeId

Identifies the OverlineColor text attribute, which specifies the color of the overline text decoration. This attribute is specified as a COLORREF, a 32-bit value used to specify an RGB or RGBA color. Variant type: VT_I4 Default value: 0

UIA_OverlineStyleAttributeId

public static final StandardTextAttributeIds UIA_OverlineStyleAttributeId

Identifies the OverlineStyle text attribute, which specifies the style of the overline text decoration. This attribute is specified as a value from the TextDecorationLineStyleEnum enumerated type. Variant type: VT_I4 Default value: TextDecorationLineStyle_None

UIA_SelectionActiveEndAttributeId

public static final StandardTextAttributeIds UIA_SelectionActiveEndAttributeId

Identifies the SelectionActiveEnd text attribute, which indicates the location of the caret relative to a text range that represents the currently selected text. This attribute is specified as a value from the ActiveEnd enumeration. Supported starting with Windows 8. Variant type: VT_I4 Default value: ActiveEnd_None

UIA_StrikethroughColorAttributeId

public static final StandardTextAttributeIds UIA_StrikethroughColorAttributeId

Identifies the StrikethroughColor text attribute, which specifies the color of the strikethrough text decoration. This attribute is specified as a COLORREF, a 32-bit value used to specify an RGB or RGBA color. Variant type: VT_I4 Default value: 0

UIA_StrikethroughStyleAttributeId

public static final StandardTextAttributeIds UIA_StrikethroughStyleAttributeId

Identifies the StrikethroughStyle text attribute, which specifies the style of the strikethrough text decoration. This attribute is specified as a value from the TextDecorationLineStyleEnum enumerated type. Variant type: VT_I4 Default value: TextDecorationLineStyle_None

UIA_StyleIdAttributeId

public static final StandardTextAttributeIds UIA_StyleIdAttributeId

Identifies the StyleId text attribute, which indicates the text styles in use for a text range. For a list of possible values, see Style Identifiers. Supported starting with Windows 8. Variant type: VT_I4 Default value: 0

UIA_StyleNameAttributeId

public static final StandardTextAttributeIds UIA_StyleNameAttributeId

Identifies the StyleName text attribute, which identifies the localized name of the text style in use for a text range. Supported starting with Windows 8. Variant type: VT_BSTR Default value: empty string

UIA_TabsAttributeId

public static final StandardTextAttributeIds UIA_TabsAttributeId

Identifies the Tabs text attribute, which is an array specifying the tab stops for the text range. Each array element specifies a distance, in points, from the leading margin. Variant type: VT_ARRAY | VT_R8 Default value: empty array

UIA_TextFlowDirectionsAttributeId

public static final StandardTextAttributeIds UIA_TextFlowDirectionsAttributeId

Identifies the TextFlowDirections text attribute, which specifies the direction of text flow. This attribute is specified as a combination of values from the FlowDirections enumerated type. Variant type: VT_I4 Default value: FlowDirections_Default

UIA_UnderlineColorAttributeId

public static final StandardTextAttributeIds UIA_UnderlineColorAttributeId

Identifies the UnderlineColor text attribute, which specifies the color of the underline text decoration. This attribute is specified as a COLORREF, a 32-bit value used to specify an RGB or RGBA color. Variant type: VT_I4 Default value: 0

UIA_UnderlineStyleAttributeId

public static final StandardTextAttributeIds UIA_UnderlineStyleAttributeId

Identifies the UnderlineStyle text attribute, which specifies the style of the underline text decoration. This attribute is specified as a value from the TextDecorationLineStyleEnum enumerated type. Variant type: VT_I4 Default value: TextDecorationLineStyle_None

UIA_SayAsInterpretAsAttributeId

public static final StandardTextAttributeIds UIA_SayAsInterpretAsAttributeId

not documented

UIA_CapStyleAttributeId

public static final StandardTextAttributeIds UIA_CapStyleAttributeId

Identifies the CapStyle text attribute, which specifies the capitalization style for the text. This attribute is specified as a value from the CapStyle enumerated type. Variant type: VT_I4 Default value: CapStyle_None

Method Details

values

public static StandardTextAttributeIds[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static StandardTextAttributeIds valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getNativeValue

public int getNativeValue()

Specified by:

getNativeValue in interface INativeConstant

Specified by:

getNativeValue in interface INativeEnum

Specified by:

getNativeValue in interface ITextAttributeId

getConstantName

public String getConstantName()

Specified by:

getConstantName in interface INativeConstant

Specified by:

getConstantName in interface INativeEnum

fromNativeValue

public static Optional<StandardTextAttributeIds> fromNativeValue(int nativeValue)