Class TextStyle

The 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 description
`getBackgroundColor()`	`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.

Return

Color

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getBaselineOffset()`

Returns the vertical offset of text from its normal position, or null if there are multiple styles on the text.

Return

TextBaselineOffset

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getFontFamily()`

Returns the font family of the text, or null if there are multiple styles on the text.

Return

String

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getFontSize()`

Returns the font size of the text in points, or null if there are multiple styles on the text.

Return

Number

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getFontWeight()`

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").

Return

Integer

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getForegroundColor()`

Returns the foreground color of the text, or null if there are multiple styles on the text.

Return

Color

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`getLink()`

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

Link

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`hasLink()`

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.

Return

Boolean

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`isBackgroundTransparent()`

Returns true if the background of the text is transparent, false if not, or null if there are multiple styles on the text.

Return

Boolean

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`isBold()`

Returns true if the text is rendered as bold, false if not, or null if there are multiple styles on the text.

Return

Boolean

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`isItalic()`

Returns true if the text is italicized, false if not, or null if there are multiple styles on the text.

Return

Boolean

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`isSmallCaps()`

Returns true if the text is in small capital letters, false if not, or null if there are multiple styles on the text.

Return

Boolean

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`isStrikethrough()`

Returns true if the text is struck through, false if not, or null if there are multiple styles on the text.

Return

Boolean

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`isUnderline()`

Returns true if the text is underlined, false if not, or null if there are multiple styles on the text.

Return

Boolean

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

https://www.googleapis.com/auth/presentations.currentonly
https://www.googleapis.com/auth/presentations

`removeLink()`

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();

Name	Type	Description
`red`	`Integer`
`green`	`Integer`
`blue`	`Integer`

Name	Type	Description
`fontFamily`	`String`
`fontWeight`	`Integer`

Name	Type	Description
`red`	`Integer`
`green`	`Integer`
`blue`	`Integer`

Class TextStyle

Methods

Detailed documentation

getBackgroundColor()

Return

Authorization

getBaselineOffset()

Return

Authorization

getFontFamily()

Return

Authorization

getFontSize()

Return

Authorization

getFontWeight()

Return

Authorization

getForegroundColor()

Return

Authorization

getLink()

Return

Authorization

hasLink()

Return

Authorization

isBackgroundTransparent()

Return

Authorization

isBold()

Return

Authorization

isItalic()

Return

Authorization

isSmallCaps()

Return

Authorization

isStrikethrough()

Return

Authorization

isUnderline()

Return

Authorization

removeLink()

Return

setBackgroundColor(color)

Parameters

Return

Authorization

setBackgroundColor(red, green, blue)

Parameters

Return

Authorization

setBackgroundColor(hexColor)

Parameters

Return

Authorization

setBackgroundColor(color)

Parameters

Return

Authorization

setBackgroundColorTransparent()

Return

Authorization

setBaselineOffset(offset)

Parameters

Return

Authorization

setBold(bold)

Parameters

Return

Authorization

setFontFamily(fontFamily)

Parameters

Return

Authorization

setFontFamilyAndWeight(fontFamily, fontWeight)

Parameters

`getBackgroundColor()`

`getBaselineOffset()`

`getFontFamily()`

`getFontSize()`

`getFontWeight()`

`getForegroundColor()`

`getLink()`

`hasLink()`

`isBackgroundTransparent()`

`isBold()`

`isItalic()`

`isSmallCaps()`

`isStrikethrough()`

`isUnderline()`

`removeLink()`

`setBackgroundColor(color)`

`setBackgroundColor(red, green, blue)`

`setBackgroundColor(hexColor)`

`setBackgroundColor(color)`

`setBackgroundColorTransparent()`

`setBaselineOffset(offset)`

`setBold(bold)`

`setFontFamily(fontFamily)`

`setFontFamilyAndWeight(fontFamily, fontWeight)`

`setFontSize(fontSize)`

`setForegroundColor(foregroundColor)`

`setForegroundColor(red, green, blue)`

`setForegroundColor(hexColor)`

`setForegroundColor(color)`

`setItalic(italic)`

`setLinkSlide(slideIndex)`

`setLinkSlide(slide)`

`setLinkSlide(slidePosition)`

`setLinkUrl(url)`

`setSmallCaps(smallCaps)`

`setStrikethrough(strikethrough)`

`setUnderline(underline)`