Parameterized Attributes

Attributed String For Range

Attributed string for the specified portion of the text associated with the currently selected item.

Pseudoclass: AXAttributedStringForRange

Cocoa constant: NSAccessibilityAttributedStringForRangeParameterizedAttribute (Available in OS X v10.4 and later.)

Carbon constant: kAXAttributedStringForRangeParameterizedAttribute (Available in OS X v10.4 and later.)

Value type: Attributed String

Parameter type: Range

Optional for Roles

Bounds For Range

Rectangle that bounds a range of text.

Pseudoclass: AXBoundsForRange

Cocoa constant: NSAccessibilityBoundsForRangeParameterizedAttribute (Available in OS X v10.3 and later.)

Carbon constant: kAXBoundsForRangeParameterizedAttribute (Available in OS X v10.3 and later.)

Value type: Rect

Parameter type: Range

Discussion

If the range crosses a line boundary, the returned rectangle will fully enclose all the lines of characters.

Optional for Roles

Cell For Column And Row

Cell for the given column and row, taking column and row spans into account.

Pseudoclass: AXCellForColumnAndRow

Cocoa constant: NSAccessibilityCellForColumnAndRowParameterizedAttribute (Available in OS X v10.6 and later.)

Carbon constant: kAXCellForColumnAndRowParameterizedAttribute (Available in OS X v10.6 and later.)

Value type: UI Element

Parameter type: Array

Optional for Roles

Layout Point For Screen Point

The point, in the coordinates of the layout area, for the given point in screen coordinates.

Pseudoclass: AXLayoutPointForScreenPoint

Cocoa constant: NSAccessibilityLayoutPointForScreenPointParameterizedAttribute (Available in OS X v10.6 and later.)

Carbon constant: kAXLayoutPointForScreenPointParameterizedAttribute (Available in OS X v10.6 and later.)

Value type: Point

Parameter type: Point

Discussion

The horizontal and vertical coordinates are given in the units returned by the AXHorizontalUnits and AXVerticalUnits attributes. This allows assistive applications to report locations in a layout area in terms of the user's units.

Required for Roles

Layout Size For Screen Size

The size, in the coordinates of the layout area, for the given size in screen coordinates.

Pseudoclass: AXLayoutSizeForScreenSize

Cocoa constant: NSAccessibilityLayoutSizeForScreenSizeParameterizedAttribute (Available in OS X v10.6 and later.)

Carbon constant: kAXLayoutSizeForScreenSizeParameterizedAttribute (Available in OS X v10.6 and later.)

Value type: Size

Parameter type: Size

Discussion

The horizontal and vertical coordinates are given in the units returned by the AXHorizontalUnits and AXVerticalUnits attributes. This allows assistive applications to report information such as the distance between two layout items in terms of the user's units.

Required for Roles

Line For Index

The line number for the given text index.

Pseudoclass: AXLineForIndex

Cocoa constant: NSAccessibilityLineForIndexParameterizedAttribute (Available in OS X v10.3 and later.)

Carbon constant: kAXLineForIndexParameterizedAttribute (Available in OS X v10.3 and later.)

Value type: Number

Parameter type: Number

Optional for Roles

Range For Index

The full range of characters.

Pseudoclass: AXRangeForIndex

Cocoa constant: NSAccessibilityRangeForIndexParameterizedAttribute (Available in OS X v10.3 and later.)

Carbon constant: kAXRangeForIndexParameterizedAttribute (Available in OS X v10.3 and later.)

Value type: Range

Parameter type: Number

Optional for Roles

Range For Line

The range of characters.

Pseudoclass: AXRangeForLine

Cocoa constant: NSAccessibilityRangeForLineParameterizedAttribute (Available in OS X v10.3 and later.)

Carbon constant: kAXRangeForLineParameterizedAttribute (Available in OS X v10.3 and later.)

Value type: Range

Parameter type: Number

Optional for Roles

Range For Position

The range of the composed character sequence at the given text index.

Pseudoclass: AXRangeForPosition

Cocoa constant: NSAccessibilityRangeForPositionParameterizedAttribute (Available in OS X v10.3 and later.)

Carbon constant: kAXRangeForPositionParameterizedAttribute (Available in OS X v10.3 and later.)

Value type: Range

Parameter type: Point

Optional for Roles

RTF For Range

Rich Text Format (RTF) data for the range.

Pseudoclass: AXRTFForRange

Cocoa constant: NSAccessibilityRTFForRangeParameterizedAttribute (Available in OS X v10.3 and later.)

Carbon constant: kAXRTFForRangeParameterizedAttribute (Available in OS X v10.3 and later.)

Value type: Data

Parameter type: Range

Optional for Roles

Screen Point For Layout Point

The point, in screen coordinates, for the given point in user coordinates.

Pseudoclass: AXScreenPointForLayoutPoint

Cocoa constant: NSAccessibilityScreenPointForLayoutPointParameterizedAttribute (Available in OS X v10.6 and later.)

Carbon constant: kAXScreenPointForLayoutPointParameterizedAttribute (Available in OS X v10.6 and later.)

Value type: Point

Parameter type: Point

Discussion

The coordinates of the parameter use the units returned by AXHorizontalUnits and AXVerticalUnits. This allows an assistive application to translate a user action—for example, moving a handle up half an inch—into the screen coordinates to correctly change the position of the handle element.

Required for Roles

Screen Size For Layout Size

The size, in screen units, for the given size in units of a layout area.

Pseudoclass: AXScreenSizeForLayoutSize

Cocoa constant: NSAccessibilityScreenSizeForLayoutSizeParameterizedAttribute (Available in OS X v10.6 and later.)

Carbon constant: kAXScreenSizeForLayoutSizeParameterizedAttribute (Available in OS X v10.6 and later.)

Value type: Size

Parameter type: Size

Discussion

The width and height of the parameter use the units returned by the AXHorizontalUnits and AXVerticalUnits attributes of the layout area. This allows an assistive application to translate from a user-specified size of a layout item to the size that it would be in screen units.

Required for Roles

String For Range

The substring.

Pseudoclass: AXStringForRange

Cocoa constant: NSAccessibilityStringForRangeParameterizedAttribute (Available in OS X v10.3 and later.)

Carbon constant: kAXStringForRangeParameterizedAttribute (Available in OS X v10.3 and later.)

Value type: String

Parameter type: Range

Optional for Roles

Style Range For Index

The full range of characters, which have the same style.

Pseudoclass: AXStyleRangeForIndex

Cocoa constant: NSAccessibilityStyleRangeForIndexParameterizedAttribute (Available in OS X v10.3 and later.)

Carbon constant: kAXStyleRangeForIndexParameterizedAttribute (Available in OS X v10.3 and later.)

Value type: Range

Parameter type: Number

Optional for Roles