An NSTextList object represents a section of text that forms a single list. 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:range(of:at:), which determines the range covered by a list, and itemNumber(in:at:), which determines the ordinal position within a list of a particular item.

Nested Types


Creating a Text List

init(markerFormat: String, options: Int)

Returns an initialized text list.

Working with Markers

var markerFormat: String

Returns the marker format string used by the receiver.

func marker(forItemNumber: Int)

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

Getting List Options

var listOptions: NSTextListOptions

Returns the list options mask value of the receiver.

Managing Item Numbering

var startingItemNumber: Int

Sets the starting item number for the text list.


The following constant specifies an option mask used with init(markerFormat:options:).

static var prependEnclosingMarker: NSTextListOptions

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


Inherits From