Returnstrueif the text is in exactly one list,falseif none of the text is
in a list, andnullif only some of the text is in a list or if the text is in multiple
lists.
Removes the paragraphs that overlap with the text from any lists.
Detailed documentation
applyListPreset(listPreset)
Applies the specifiedListPresetto 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 aListwith 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.
Returns theListthe text is in, ornullif none of the text is in a list, or
part of the text is in a list, or the text is in multiple lists. CallisInList()to
determine whether the text is in a list.
Returnstrueif the text is in exactly one list,falseif none of the text is
in a list, andnullif only some of the text is in a list or if the text is in multiple
lists.
Return
Boolean
Authorization
Scripts that use this method require authorization with one or more of the followingscopes:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eListStyle\u003c/code\u003e encompasses methods to manipulate the styling and structure of lists within text ranges in Google Slides.\u003c/p\u003e\n"],["\u003cp\u003eIt provides functionalities to apply list presets, determine nesting levels, and check if text resides within a list.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve the rendered glyph or the associated \u003ccode\u003eList\u003c/code\u003e object for further manipulation.\u003c/p\u003e\n"],["\u003cp\u003eMethods are available to remove text from lists while preserving visual indentation.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization with specific scopes is required to utilize these methods in your scripts.\u003c/p\u003e\n"]]],["The `ListStyle` object manages text list formatting. Key actions include: applying a `ListPreset` to paragraphs, which also adjusts nesting levels by removing leading tabs; retrieving the rendered glyph, the associated `List` object, or the nesting level. It can also check if the text is within a list, and remove text from any existing list. Additionally, removing text from a list visually preserves nesting through indenting. Each method requires specific authorization scopes.\n"],null,["# Class ListStyle\n\nListStyle\n\nThe list styling for a range of text. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [applyListPreset(listPreset)](#applyListPreset(ListPreset)) | [ListStyle](#) | Applies the specified [ListPreset](/apps-script/reference/slides/list-preset) to all of the paragraphs that overlap with the text. |\n| [getGlyph()](#getGlyph()) | `String` | Returns the rendered glyph for the text. |\n| [getList()](#getList()) | [List](/apps-script/reference/slides/list) | Returns the [List](/apps-script/reference/slides/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. |\n| [getNestingLevel()](#getNestingLevel()) | `Integer` | Returns the 0-based nesting level of the text. |\n| [isInList()](#isInList()) | `Boolean` | 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. |\n| [removeFromList()](#removeFromList()) | [ListStyle](#) | Removes the paragraphs that overlap with the text from any lists. |\n\nDetailed documentation\n----------------------\n\n### `apply``List``Preset(listPreset)`\n\nApplies the specified [ListPreset](/apps-script/reference/slides/list-preset) to all of the paragraphs that overlap with the text.\n\nThe nesting level of each paragraph is determined by counting leading tabs in front of each\nparagraph. To avoid excess space between the glyphs and the corresponding paragraph, these\nleading tabs are removed by this method.\n\nIf the paragraph immediately before paragraphs being updated is in a [List](/apps-script/reference/slides/list) with a\nmatching list preset and the paragraphs being updated are not already in a different list, the\nparagraphs being updated are added to that preceding list.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------|---------------------------------------------------------|-------------|\n| `list``Preset` | [ListPreset](/apps-script/reference/slides/list-preset) | |\n\n#### Return\n\n\n[ListStyle](#)\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`\n\n*** ** * ** ***\n\n### `get``Glyph()`\n\nReturns the rendered glyph for the text. Returns `null` if the text spans more than one\nparagraph or the text is not in a list.\n\n#### Return\n\n\n`String`\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`\n\n*** ** * ** ***\n\n### `get``List()`\n\nReturns the [List](/apps-script/reference/slides/list) the text is in, or `null` if none of the text is in a list, or\npart of the text is in a list, or the text is in multiple lists. Call [isInList()](#isInList()) to\ndetermine whether the text is in a list.\n\n#### Return\n\n\n[List](/apps-script/reference/slides/list)\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`\n\n*** ** * ** ***\n\n### `get``Nesting``Level()`\n\nReturns the 0-based nesting level of the text. Returns `null` if the text is not in a\nlist or there are mixed values.\n\n#### Return\n\n\n`Integer`\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`\n\n*** ** * ** ***\n\n### `is``In``List()`\n\nReturns `true` if the text is in exactly one list, `false` if none of the text is\nin a list, and `null` if only some of the text is in a list or if the text is in multiple\nlists.\n\n#### Return\n\n\n`Boolean`\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`\n\n*** ** * ** ***\n\n### `remove``From``List()`\n\nRemoves the paragraphs that overlap with the text from any lists.\n\nThe nesting level of each paragraph is visually preserved by adding indent to the start of\nthe corresponding paragraph.\n\n#### Return\n\n\n[ListStyle](#)\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/presentations.currentonly`\n- `https://www.googleapis.com/auth/presentations`"]]
