Platforms to show: All Mac Windows Linux Cross-Platform

NSTextListMBS class

Type Topic Plugin Version macOS Windows Linux iOS Targets
class Cocoa Text MBS MacBase Plugin 18.1 ✅ Yes ❌ No ❌ No ✅ Yes All
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, such as rangeOfTextList, which determines the range covered by a list, and itemNumberInTextList, which determines the ordinal position within a list of a particular item.

Constants

Constant Value Description
NSTextListPrependEnclosingMarker 1 One of the constants for options. Specifies that a nested list should include the marker for its enclosing superlist before its own marker.

This class has no sub classes.

Some methods using this class:

Some properties using for this class:

Some examples using this class:

Blog Entries

Xojo Developer Magazine

Release notes


The items on this page are in the following plugins: MBS MacBase Plugin.


NSTextFinderMBS   -   NSTextMBS


💬 Ask a question or report a problem
The biggest plugin in space...