Stay organized with collections Save and categorize content based on your preferences.
TextStyleThe style of text.
Read methods in this class return null if the corresponding TextRange spans multiple text runs, and those runs have different values for the read method being called. To avoid this, query for text styles using the TextRanges returned by the TextRange.getRuns() method.
If you use methods that edit how text fits within a shape, any autofit settings applied to the text styles are deactivated.
Methods Method Return type Brief descriptiongetBackgroundColor() Color Returns the background color of the text, or null if there are multiple styles on the text. getBaselineOffset() TextBaselineOffset Returns the vertical offset of text from its normal position, or null if there are multiple styles on the text. getFontFamily() String Returns the font family of the text, or null if there are multiple styles on the text. getFontSize() Number Returns the font size of the text in points, or null if there are multiple styles on the text. getFontWeight() Integer Returns the font weight of the text, or null if there are multiple styles on the text. getForegroundColor() Color Returns the foreground color of the text, or null if there are multiple styles on the text. getLink() Link Returns the Link on the text, or null if there is no link or if the link is on part of the text or if there are multiple links. hasLink() Boolean Returns true if there is link on the text, false if not, or null if the link is on part of the text or there are multiple links. isBackgroundTransparent() Boolean Returns true if the background of the text is transparent, false if not, or null if there are multiple styles on the text. isBold() Boolean Returns true if the text is rendered as bold, false if not, or null if there are multiple styles on the text. isItalic() Boolean Returns true if the text is italicized, false if not, or null if there are multiple styles on the text. isSmallCaps() Boolean Returns true if the text is in small capital letters, false if not, or null if there are multiple styles on the text. isStrikethrough() Boolean Returns true if the text is struck through, false if not, or null if there are multiple styles on the text. isUnderline() Boolean Returns true if the text is underlined, false if not, or null if there are multiple styles on the text. removeLink() TextStyle Removes a Link. setBackgroundColor(color) TextStyle Sets the background color of the text. setBackgroundColor(red, green, blue) TextStyle Sets the background color of the text to the given RGB values from 0 to 255. setBackgroundColor(hexColor) TextStyle Sets the background color of the text to the given hex color string. setBackgroundColor(color) TextStyle Sets the background color of the text to the given ThemeColorType. setBackgroundColorTransparent() TextStyle Sets the background color of the text to transparent. setBaselineOffset(offset) TextStyle Sets the vertical offset of the text relative to its normal position. setBold(bold) TextStyle Sets whether the text should be rendered as bold. setFontFamily(fontFamily) TextStyle Sets the font family of the text . setFontFamilyAndWeight(fontFamily, fontWeight) TextStyle Sets the font family and weight of the text. setFontSize(fontSize) TextStyle Sets the font size of the text, in points. setForegroundColor(foregroundColor) TextStyle Sets the foreground color of the text. setForegroundColor(red, green, blue) TextStyle Sets the foreground color of the text to the given RGB values from 0 to 255. setForegroundColor(hexColor) TextStyle Sets the foreground color of the text to the given hex color string. setForegroundColor(color) TextStyle Sets the foreground color of the text to the given ThemeColorType. setItalic(italic) TextStyle Sets the whether the text is italicized. setLinkSlide(slideIndex) TextStyle Sets a Link to the given Slide using the zero-based index of the slide. setLinkSlide(slide) TextStyle Sets a Link to the given Slide, the link is set by the given slide ID. setLinkSlide(slidePosition) TextStyle Sets a Link to the given Slide using the relative position of the slide. setLinkUrl(url) TextStyle Sets a Link to the given non-empty URL string. setSmallCaps(smallCaps) TextStyle Sets whether the text is rendered in small capital letters. setStrikethrough(strikethrough) TextStyle Sets whether the text is struck through. setUnderline(underline) TextStyle Sets whether the text is underlined. Detailed documentation getBackgroundColor()
Returns the background color of the text, or null if there are multiple styles on the text.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsgetBaselineOffset()
Returns the vertical offset of text from its normal position, or null if there are multiple styles on the text.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsgetFontFamily()
Returns the font family of the text, or null if there are multiple styles on the text.
String
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsgetFontSize()
Returns the font size of the text in points, or null if there are multiple styles on the text.
Number
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsgetFontWeight()
Returns the font weight of the text, or null if there are multiple styles on the text.
The weight is a multiple of 100 between 100 and 900, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, section 15.6, with non-numerical values disallowed. Weights greater than or equal to 700 are considered bold, in which case isBold() returns true. The default value is 400 ("normal").
Integer
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsgetForegroundColor()
Returns the foreground color of the text, or null if there are multiple styles on the text.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsgetLink()
Returns the Link on the text, or null if there is no link or if the link is on part of the text or if there are multiple links. Call hasLink() to determine whether the text has no link.
const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
const textLink = shape.getText().getTextStyle().getLink();
if (textLink != null) {
Logger.log(`Shape text has a link of type: ${textLink.getLinkType()}`);
} Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationshasLink()
Returns true if there is link on the text, false if not, or null if the link is on part of the text or there are multiple links.
Links cannot be set on newline characters. Therefore, if the TextRange contains a newline character, this method always returns either null or false.
Boolean
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsisBackgroundTransparent()
Returns true if the background of the text is transparent, false if not, or null if there are multiple styles on the text.
Boolean
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsisBold()
Returns true if the text is rendered as bold, false if not, or null if there are multiple styles on the text.
Boolean
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsisItalic()
Returns true if the text is italicized, false if not, or null if there are multiple styles on the text.
Boolean
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsisSmallCaps()
Returns true if the text is in small capital letters, false if not, or null if there are multiple styles on the text.
Boolean
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsisStrikethrough()
Returns true if the text is struck through, false if not, or null if there are multiple styles on the text.
Boolean
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsisUnderline()
Returns true if the text is underlined, false if not, or null if there are multiple styles on the text.
Boolean
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsremoveLink()
Removes a Link.
Removing a link removes the hyperlink foreground color and underline style on the text. If possible, these styles are applied to match the text preceding the link.
const textRange = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText(); textRange.getTextStyle().removeLink();Return
setBackgroundColor(color)
Sets the background color of the text.
Parameters Name Type Descriptioncolor Color Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetBackgroundColor(red, green, blue)
Sets the background color of the text to the given RGB values from 0 to 255.
Parameters Name Type Descriptionred Integer green Integer blue Integer Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetBackgroundColor(hexColor)
Sets the background color of the text to the given hex color string.
The hex string must be in the format '#RRGGBB'. For example, pink would be represented as '#FFC0CB'.
Parameters Name Type DescriptionhexColor String Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetBackgroundColor(color)
Sets the background color of the text to the given ThemeColorType.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetBackgroundColorTransparent()
Sets the background color of the text to transparent.
Return AuthorizationScripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetBaselineOffset(offset)
Sets the vertical offset of the text relative to its normal position.
Parameters Return AuthorizationScripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetBold(bold)
Sets whether the text should be rendered as bold.
Changing the text's boldness updates the font weight used to render the text.
Parameters Name Type Descriptionbold Boolean Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetFontFamily(fontFamily)
Sets the font family of the text .
Parameters Name Type DescriptionfontFamily String Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetFontFamilyAndWeight(fontFamily, fontWeight)
Sets the font family and weight of the text.
The weight is a multiple of 100 between 100 and 900, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, section 15.6, with non-numerical values disallowed. Weights greater than or equal to 700 are considered bold, in which case isBold() returns true. The default value is 400 ("normal").
fontFamily String fontWeight Integer Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetFontSize(fontSize)
Sets the font size of the text, in points.
Parameters Name Type DescriptionfontSize Number Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetForegroundColor(foregroundColor)
Sets the foreground color of the text.
Parameters Name Type DescriptionforegroundColor Color Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetForegroundColor(red, green, blue)
Sets the foreground color of the text to the given RGB values from 0 to 255.
Parameters Name Type Descriptionred Integer green Integer blue Integer Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetForegroundColor(hexColor)
Sets the foreground color of the text to the given hex color string.
The hex string must be in the format '#RRGGBB'. For example, pink would be represented as '#FFC0CB'.
Parameters Name Type DescriptionhexColor String Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetForegroundColor(color)
Sets the foreground color of the text to the given ThemeColorType.
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetItalic(italic)
Sets the whether the text is italicized.
Parameters Name Type Descriptionitalic Boolean Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetLinkSlide(slideIndex)
Sets a Link to the given Slide using the zero-based index of the slide.
Setting a link changes the style of the text to be underlined and to have a ThemeColorType.HYPERLINK foreground color. This can be changed via setForegroundColor(hexColor) and setUnderline(underline).
Since links cannot be set on newline characters, newline characters in the TextRange are ignored.
// Set a link to the first slide of the presentation. const presentation = SlidesApp.getActivePresentation(); const slide = presentation.getSlides()[0]; const textRange = slide.getShapes()[0].getText(); textRange.getTextStyle().setLinkSlide(0);Parameters Name Type Description
slideIndex Integer The zero-based index to the slide. Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetLinkSlide(slide)
Sets a Link to the given Slide, the link is set by the given slide ID.
Setting a link changes the style of the text to be underlined and to have a ThemeColorType.HYPERLINK foreground color. This can be changed via setForegroundColor(hexColor) and setUnderline(underline).
Since links cannot be set on newline characters, newline characters in the TextRange are ignored.
// Set a link to the first slide of the presentation. const presentation = SlidesApp.getActivePresentation(); const slide = presentation.getSlides()[0]; const textRange = slide.getShapes()[0].getText(); textRange.getTextStyle().setLinkSlide(slide);Parameters Name Type Description
slide Slide The Slide to be linked. Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetLinkSlide(slidePosition)
Sets a Link to the given Slide using the relative position of the slide.
Setting a link changes the style of the text to be underlined and to have a ThemeColorType.HYPERLINK foreground color. This can be changed via setForegroundColor(hexColor) and setUnderline(underline).
Since links cannot be set on newline characters, newline characters in the TextRange are ignored.
// Set a link to the first slide of the presentation. const textRange = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText(); textRange.getTextStyle().setLinkSlide(SlidesApp.SlidePosition.FIRST_SLIDE);Parameters Return Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetLinkUrl(url)
Sets a Link to the given non-empty URL string.
Setting a link changes the style of the text to be underlined and to have a ThemeColorType.HYPERLINK foreground color. This can be changed via setForegroundColor(hexColor) and setUnderline(underline).
Since links cannot be set on newline characters, newline characters in the TextRange are ignored.
// Set a link to the URL.
const textRange = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText();
textRange.getTextStyle().setLinkUrl('https://slides.google.com'); Parameters Name Type Description url String The URL string. Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetSmallCaps(smallCaps)
Sets whether the text is rendered in small capital letters.
Parameters Name Type DescriptionsmallCaps Boolean Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetStrikethrough(strikethrough)
Sets whether the text is struck through.
Parameters Name Type Descriptionstrikethrough Boolean Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationssetUnderline(underline)
Sets whether the text is underlined.
Parameters Name Type Descriptionunderline Boolean Return
Authorization
Scripts that use this method require authorization with one or more of the following scopes:
https://www.googleapis.com/auth/presentations.currentonlyhttps://www.googleapis.com/auth/presentationsExcept as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[[["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-03 UTC."],[[["`TextStyle` in Google Slides controls text formatting and can have variations within a single text range."],["The `TextRange.getRuns()` method is the reliable way to get style information, as other methods might return `null` due to style conflicts."],["`TextStyle` offers a variety of methods for getting, setting, and managing text styles like font, color, and links in Google Apps Script."],["All `TextStyle` methods in Apps Script require authorization with specific Google Slides scopes."],["Editing text that autofits to a shape will deactivate the autofit setting."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4