Class ListStyle

ListStyle

The list styling for a range of text.

Methods

MethodReturn typeBrief description
applyListPreset(listPreset)ListStyleApplies the specified ListPreset to all of the paragraphs that overlap with the text.
getGlyph()StringReturns the rendered glyph for the text.
getList()ListReturns the List the text is in, or null if none of the text is in a list, or part of the text is in a list, or the text is in multiple lists.
getNestingLevel()IntegerReturns the 0-based nesting level of the text.
isInList()BooleanReturns true if the text is in exactly one list, false if none of the text is in a list, and null if only some of the text is in a list or if the text is in multiple lists.
removeFromList()ListStyleRemoves the paragraphs that overlap with the text from any lists.

Detailed documentation

applyListPreset(listPreset)

Applies the specified ListPreset to all of the paragraphs that overlap with the text.

The nesting level of each paragraph is determined by counting leading tabs in front of each paragraph. To avoid excess space between the glyphs and the corresponding paragraph, these leading tabs are removed by this method.

If the paragraph immediately before paragraphs being updated is in a List with a matching list preset and the paragraphs being updated are not already in a different list, the paragraphs being updated are added to that preceding list.

Parameters

NameTypeDescription
listPresetListPreset

Return

ListStyle


getGlyph()

Returns the rendered glyph for the text. Returns null if the text spans more than one paragraph or the text is not in a list.

Return

String


getList()

Returns the List the text is in, or null if none of the text is in a list, or part of the text is in a list, or the text is in multiple lists. Call isInList() to determine whether the text is in a list.

Return

List


getNestingLevel()

Returns the 0-based nesting level of the text. Returns null if the text is not in a list or there are mixed values.

Return

Integer


isInList()

Returns true if the text is in exactly one list, false if none of the text is in a list, and null if only some of the text is in a list or if the text is in multiple lists.

Return

Boolean


removeFromList()

Removes the paragraphs that overlap with the text from any lists.

The nesting level of each paragraph is visually preserved by adding indent to the start of the corresponding paragraph.

Return

ListStyle

Send feedback about...

Apps Script
Apps Script