The style of text.
Read methods in this class return null if the corresponding Text 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 Texts returned by the Text 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 |
|---|---|---|
get | Color | Returns the background color of the text, or null if there are multiple styles on the text. |
get | Text | Returns the vertical offset of text from its normal position, or null if there are multiple styles on the text. |
get | String | Returns the font family of the text, or null if there are multiple styles on the text. |
get | Number | Returns the font size of the text in points, or null if there are multiple styles on the text. |
get | Integer | Returns the font weight of the text, or null if there are multiple styles on the text. |
get | Color | Returns the foreground color of the text, or null if there are multiple styles on the text. |
get | 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. |
has | 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. |
is | Boolean | Returns true if the background of the text is transparent, false if not, or null if there are multiple styles on the text. |
is | Boolean | Returns true if the text is rendered as bold, false if not, or null if there are multiple styles on the text. |
is | Boolean | Returns true if the text is italicized, false if not, or null if there are multiple styles on the text. |
is | Boolean | Returns true if the text is in small capital letters, false if not, or null if there are multiple styles on the text. |
is | Boolean | Returns true if the text is struck through, false if not, or null if there are multiple styles on the text. |
is | Boolean | Returns true if the text is underlined, false if not, or null if there are multiple styles on the text. |
remove | Text | Removes a Link. |
set | Text | Sets the background color of the text. |
set | Text | Sets the background color of the text to the given RGB values from 0 to 255. |
set | Text | Sets the background color of the text to the given hex color string. |
set | Text | Sets the background color of the text to the given Theme. |
set | Text | Sets the background color of the text to transparent. |
set | Text | Sets the vertical offset of the text relative to its normal position. |
set | Text | Sets whether the text should be rendered as bold. |
set | Text | Sets the font family of the text . |
set | Text | Sets the font family and weight of the text. |
set | Text | Sets the font size of the text, in points. |
set | Text | Sets the foreground color of the text. |
set | Text | Sets the foreground color of the text to the given RGB values from 0 to 255. |
set | Text | Sets the foreground color of the text to the given hex color string. |
set | Text | Sets the foreground color of the text to the given Theme. |
set | Text | Sets the whether the text is italicized. |
set | Text | Sets a Link to the given Slide using the zero-based index of the slide. |
set | Text | Sets a Link to the given Slide, the link is set by the given slide ID. |
set | Text | Sets a Link to the given Slide using the relative position of the slide. |
set | Text | Sets a Link to the given non-empty URL string. |
set | Text | Sets whether the text is rendered in small capital letters. |
set | Text | Sets whether the text is struck through. |
set | Text | 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
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/presentations
getBaselineOffset()
Returns the vertical offset of text from its normal position, or null if there are multiple styles on the text.
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/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.currentonlyhttps://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.currentonlyhttps://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 is 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.currentonlyhttps://www.googleapis.com/auth/presentations
getForegroundColor()
Returns the foreground color of the text, or null if there are multiple styles on the text.
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/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 has to determine whether the text has no link.
constshape=SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];consttextLink=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/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 Text 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.currentonlyhttps://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.currentonlyhttps://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.currentonlyhttps://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.currentonlyhttps://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.currentonlyhttps://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.currentonlyhttps://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.currentonlyhttps://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.
consttextRange=SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText();textRange.getTextStyle().removeLink();
Return
setBackgroundColor(color)
setBackgroundColor(red, green, blue)
Sets the background color of the text to the given RGB values from 0 to 255.
Parameters
| Name | Type | Description |
|---|---|---|
red | 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/presentations
setBackgroundColor(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 | Description |
|---|---|---|
hex | 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/presentations
setBackgroundColor(color)
Sets the background color of the text to the given Theme.
Parameters
| Name | Type | Description |
|---|---|---|
color | Theme |
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/presentations
setBackgroundColorTransparent()
setBaselineOffset(offset)
Sets the vertical offset of the text relative to its normal position.
Parameters
| Name | Type | Description |
|---|---|---|
offset | Text |
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/presentations
setBold(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 | Description |
|---|---|---|
bold | 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/presentations
setFontFamily(fontFamily)
Sets the font family of the text .
Parameters
| Name | Type | Description |
|---|---|---|
font | 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/presentations
setFontFamilyAndWeight(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 is returns true. The default value is 400 ("normal").
Parameters
| Name | Type | Description |
|---|---|---|
font | String | |
font | 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/presentations
setFontSize(fontSize)
Sets the font size of the text, in points.
Parameters
| Name | Type | Description |
|---|---|---|
font | 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/presentations
setForegroundColor(foregroundColor)
Sets the foreground color of the text.
Parameters
| Name | Type | Description |
|---|---|---|
foreground | 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/presentations
setForegroundColor(red, green, blue)
Sets the foreground color of the text to the given RGB values from 0 to 255.
Parameters
| Name | Type | Description |
|---|---|---|
red | 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/presentations
setForegroundColor(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 | Description |
|---|---|---|
hex | 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/presentations
setForegroundColor(color)
Sets the foreground color of the text to the given Theme.
Parameters
| Name | Type | Description |
|---|---|---|
color | Theme |
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/presentations
setItalic(italic)
Sets the whether the text is italicized.
Parameters
| Name | Type | Description |
|---|---|---|
italic | 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/presentations
setLinkSlide(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 Theme foreground color. This can be changed via set and set.
Since links cannot be set on newline characters, newline characters in the Text are ignored.
// Set a link to the first slide of the presentation.constpresentation=SlidesApp.getActivePresentation();constslide=presentation.getSlides()[0];consttextRange=slide.getShapes()[0].getText();textRange.getTextStyle().setLinkSlide(0);
Parameters
| Name | Type | Description |
|---|---|---|
slide | 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/presentations
setLinkSlide(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 Theme foreground color. This can be changed via set and set.
Since links cannot be set on newline characters, newline characters in the Text are ignored.
// Set a link to the first slide of the presentation.constpresentation=SlidesApp.getActivePresentation();constslide=presentation.getSlides()[0];consttextRange=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/presentations
setLinkSlide(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 Theme foreground color. This can be changed via set and set.
Since links cannot be set on newline characters, newline characters in the Text are ignored.
// Set a link to the first slide of the presentation.consttextRange=SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText();textRange.getTextStyle().setLinkSlide(SlidesApp.SlidePosition.FIRST_SLIDE);
Parameters
| Name | Type | Description |
|---|---|---|
slide | Slide | The relative 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/presentations
setLinkUrl(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 Theme foreground color. This can be changed via set and set.
Since links cannot be set on newline characters, newline characters in the Text are ignored.
// Set a link to the URL.consttextRange=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/presentations
setSmallCaps(smallCaps)
Sets whether the text is rendered in small capital letters.
Parameters
| Name | Type | Description |
|---|---|---|
small | 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/presentations
setStrikethrough(strikethrough)
Sets whether the text is struck through.
Parameters
| Name | Type | Description |
|---|---|---|
strikethrough | 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/presentations
setUnderline(underline)
Sets whether the text is underlined.
Parameters
| Name | Type | Description |
|---|---|---|
underline | 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/presentations
