Class

NSTextList

A section of text that forms a single list.

Declaration

@interface NSTextList : NSObject

Overview

The visible elements of the list, including list markers, appear in the text as they do for lists created by hand. The list object, however, allows the list to be recognized as such by the text system. This enables automatic creation of markers and spacing. Text lists are used in HTML import and export.

Text lists appear as attributes on paragraphs, as part of the paragraph style. An NSParagraphStyle may have an array of text lists, representing the nested lists containing the paragraph, in order from outermost to innermost. For example, if list1 contains four paragraphs, the middle two of which are also in the inner list2, then the text lists array for the first and fourth paragraphs is (list1), while the text lists array for the second and third paragraphs is (list1, list2).

The methods implementing this are textLists on NSParagraphStyle, and textLists on NSMutableParagraphStyle.

In addition, NSAttributedString has convenience methods for lists, such as rangeOfTextList:atIndex:, which determines the range covered by a list, and itemNumberInTextList:atIndex:, which determines the ordinal position within a list of a particular item.

Topics

Creating a Text List

- initWithMarkerFormat:options:

Returns an initialized text list.

Working with Markers

markerFormat

Returns the marker format string used by the receiver.

- markerForItemNumber:

Returns the computed value for a specific ordinal position in the list.

Getting List Options

listOptions

Returns the list options mask value of the receiver.

Managing Item Numbering

startingItemNumber

Sets the starting item number for the text list.

Constants

The following constant specifies an option mask used with initWithMarkerFormat:options:.

NSTextListPrependEnclosingMarker

Specifies that a nested list should include the marker for its enclosing superlist before its own marker.

Relationships

Inherits From

See Also

Formatted Content

NSParagraphStyle

The paragraph or ruler attributes used by an attributed string.

NSMutableParagraphStyle

An object that enables changing the values of the subattributes in a paragraph style attribute.

NSTextTable

An object that represents a text table as a whole.

NSTextTableBlock

A text block that appears as a cell in a text table.

NSTextTab

A tab in an NSParagraphStyle object, storing an alignment type and location.