Class TextStyle

TextStyle

文本的样式。

如果相应的 TextRange 跨越，则此类中的读取方法会返回 null 多次文本运行，这些运行对于所调用的 read 方法具有不同的值。接收者 为避免这种情况，请使用 TextRange.getRuns() 方法返回的 TextRange 查询文本样式。

如果您使用方法修改文字在形状中的调整方式，则应用于 文本样式。

方法

方法返回类型简介
getBackgroundColor()Color返回文本的背景颜色；如果文本上有多个样式，则返回 null 文本。
getBaselineOffset()TextBaselineOffset返回文本相对于正常位置的垂直偏移量；如果有null 为文本添加多种样式
getFontFamily()String返回文本的字体系列，如果文本有多种样式，则返回 null。
getFontSize()Number返回文本的字体大小（以磅为单位），如果文本存在多种样式，则返回 null 文本。
getFontWeight()Integer返回文本的字体粗细，如果文本有多种样式，则返回 null。
getForegroundColor()Color返回文本的前景色，或者如果文本上有多种样式，null 文本。
getLink()Link返回对文本的 Link，如果没有链接或链接打开，则返回 null 部分文本或有多个链接。
hasLink()Boolean如果文本中有链接，则返回 true；如果没有链接，则返回 false；如果文本中有链接，则返回 null 链接位于文本部分或有多个链接。
isBackgroundTransparent()Boolean如果文本背景是透明的，则返回 true；否则返回 false， 如果文本有多种样式，则返回 null。
isBold()Boolean如果文本以粗体呈现，则返回 true；如果不以粗体呈现，则返回 false；如果文本呈现为粗体，则返回 null 文本上有多种样式。
isItalic()Boolean如果文本为斜体，则返回 true；如果文本为斜体，则返回 false，如果文本为斜体则返回 null 是文本的多种样式。
isSmallCaps()Boolean如果文本采用小大写字母，则返回 true；如果文本采用多种样式，返回 false 或 null。
isStrikethrough()Boolean如果文本被删除线，则返回 true；如果没有删除线，则返回 false；如果文本被删除，则返回 null 文本上有多种样式。
isUnderline()Boolean如果文本带下划线，则返回 true；如果没有带下划线，则返回 false；如果文本带下划线，则返回 null 是文本的多种样式。
removeLink()TextStyle移除 Link。
setBackgroundColor(color)TextStyle设置文本的背景颜色。
setBackgroundColor(red, green, blue)TextStyle将文本的背景颜色设为给定的 RGB 值，范围为 0 到 255。
setBackgroundColor(hexColor)TextStyle将文本的背景颜色设为指定的十六进制颜色字符串。
setBackgroundColor(color)TextStyle将文本的背景颜色设为给定 ThemeColorType。
setBackgroundColorTransparent()TextStyle将文本的背景颜色设为透明。
setBaselineOffset(offset)TextStyle设置文本相对于其正常位置的垂直偏移量。
setBold(bold)TextStyle设置文本是否以粗体呈现。
setFontFamily(fontFamily)TextStyle设置文本的字体系列。
setFontFamilyAndWeight(fontFamily, fontWeight)TextStyle设置文本的字体系列和粗细。
setFontSize(fontSize)TextStyle设置文本的字体大小（以点为单位）。
setForegroundColor(foregroundColor)TextStyle设置文本的前景色。
setForegroundColor(red, green, blue)TextStyle将文本的前景色设为给定的 RGB 值，范围为 0 到 255。
setForegroundColor(hexColor)TextStyle将文本的前景色设置为指定的十六进制颜色字符串。
setForegroundColor(color)TextStyle将文本的前景色设置为指定的 ThemeColorType。
setItalic(italic)TextStyle设置文本是否以斜体显示。
setLinkSlide(slideIndex)TextStyle使用幻灯片的索引（从零开始）将 Link 设置为指定的 Slide。
setLinkSlide(slide)TextStyle将 Link 设置为指定的 Slide，链接由指定的幻灯片 ID 设置。
setLinkSlide(slidePosition)TextStyle使用幻灯片的相对位置将 Link 设置为指定的 Slide。
setLinkUrl(url)TextStyle将 Link 设置为给定的非空网址字符串。
setSmallCaps(smallCaps)TextStyle设置文字是否以大写字母显示。
setStrikethrough(strikethrough)TextStyle设置是否给文本添加删除线。
setUnderline(underline)TextStyle设置文本是否为下划线。

详细文档

getBackgroundColor()

返回文本的背景颜色；如果文本上有多个样式，则返回 null 文本。

返回

Color

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

getBaselineOffset()

返回文本相对于其正常位置的垂直偏移量；如果有null 为文本添加多种样式

返回

TextBaselineOffset

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

getFontFamily()

返回文本的字体系列，如果文本有多种样式，则返回 null。

返回

String

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

getFontSize()

返回文本的字体大小（以磅为单位），如果文本存在多种样式，则返回 null 文本。

返回

Number

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

getFontWeight()

返回文本的字体粗细，如果文本有多种样式，则返回 null。

权重是 100 到 900（含）之间的 100 的倍数。此范围对应的是 CSS 2.1 规范第 15.6 节中所述的数值以及 不允许使用非数字值。权重大于或等于 700 时， 在这种情况下，isBold() 会返回 true。默认值为 400 （“正常”）。

返回

Integer

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

getForegroundColor()

返回文本的前景色，或者如果文本上有多种样式，null 文本。

返回

Color

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

返回对文本的 Link，如果没有链接或链接打开，则返回 null 部分文本或有多个链接。调用 hasLink() 来确定是否 文本没有链接。 

var textLink = shape.getText().getTextStyle().getLink();
if (textLink != null) {
  Logger.log('Shape text has a link of type: ' + textLink.getLinkType());
}

返回

Link

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

如果文本中有链接，则返回 true；如果没有链接，则返回 false；如果文本中有链接，则返回 null 或有多个链接。

不得使用换行符设置链接。因此，如果 TextRange 包含 换行符，则此方法始终返回 null 或 false。

返回

Boolean

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

isBackgroundTransparent()

如果文本背景是透明的，则返回 true；否则返回 false， 如果文本有多种样式，则返回 null。

返回

Boolean

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

isBold()

如果文本以粗体呈现，则返回 true；如果不以粗体呈现，则返回 false；如果文本呈现为粗体，则返回 null 文本上有多种样式。

返回

Boolean

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

isItalic()

如果文本为斜体，则返回 true；如果文本为斜体，则返回 false，如果文本为斜体则返回 null 是文本的多种样式。

返回

Boolean

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

isSmallCaps()

如果文本采用小大写字母，则返回 true；如果文本采用多种样式，返回 false 或 null。

返回

Boolean

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

isStrikethrough()

如果文本被删除线，则返回 true；如果没有删除线，则返回 false；如果文本被删除，则返回 null 文本上有多种样式。

返回

Boolean

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

isUnderline()

如果文本带下划线，则返回 true；如果没有带下划线，则返回 false；如果文本带下划线，则返回 null 是文本的多种样式。

返回

Boolean

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

移除 Link。

移除链接后，文本中的超链接前景色和下划线样式也将一并移除。如果 那么系统会应用这些样式来匹配链接前面的文本。 

text.getTextStyle().removeLink();

返回

TextStyle

setBackgroundColor(color)

设置文本的背景颜色。

参数

名称类型说明
colorColor

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setBackgroundColor(red, green, blue)

将文本的背景颜色设为给定的 RGB 值，范围为 0 到 255。

参数

名称类型说明
redInteger
greenInteger
blueInteger

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setBackgroundColor(hexColor)

将文本的背景颜色设为指定的十六进制颜色字符串。

十六进制字符串格式必须为“#RRGGBB”。例如，粉色将表示为 “#FFC0CB”。

参数

名称类型说明
hexColorString

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setBackgroundColor(color)

将文本的背景颜色设为给定 ThemeColorType。

参数

名称类型说明
colorThemeColorType

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setBackgroundColorTransparent()

将文本的背景颜色设为透明。

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setBaselineOffset(offset)

设置文本相对于其正常位置的垂直偏移量。

参数

名称类型说明
offsetTextBaselineOffset

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setBold(bold)

设置文本是否以粗体呈现。

更改文本的粗细会更新用于渲染文本的字体粗细。

参数

名称类型说明
boldBoolean

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFontFamily(fontFamily)

设置文本的字体系列。

参数

名称类型说明
fontFamilyString

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFontFamilyAndWeight(fontFamily, fontWeight)

设置文本的字体系列和粗细。

权重是 100 到 900（含）之间的 100 的倍数。此范围对应的是 CSS 2.1 规范第 15.6 节中所述的数值以及 不允许使用非数字值。权重大于或等于 700 时， 在这种情况下，isBold() 会返回 true。默认值为 400 （“正常”）。

参数

名称类型说明
fontFamilyString
fontWeightInteger

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setFontSize(fontSize)

设置文本的字体大小（以点为单位）。

参数

名称类型说明
fontSizeNumber

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setForegroundColor(foregroundColor)

设置文本的前景色。

参数

名称类型说明
foregroundColorColor

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setForegroundColor(red, green, blue)

将文本的前景色设为给定的 RGB 值，范围为 0 到 255。

参数

名称类型说明
redInteger
greenInteger
blueInteger

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setForegroundColor(hexColor)

将文本的前景色设置为指定的十六进制颜色字符串。

十六进制字符串格式必须为“#RRGGBB”。例如，粉色将表示为 “#FFC0CB”。

参数

名称类型说明
hexColorString

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setForegroundColor(color)

将文本的前景色设置为指定的 ThemeColorType。

参数

名称类型说明
colorThemeColorType

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setItalic(italic)

设置文本是否以斜体显示。

参数

名称类型说明
italicBoolean

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setLinkSlide(slideIndex)

使用幻灯片的索引（从零开始）将 Link 设置为指定的 Slide。

设置链接会更改带下划线的文本样式，并将其前景色设为 ThemeColorType.HYPERLINK。这可通过 setForegroundColor(hexColor) 和 setUnderline(underline) 进行更改。

由于无法为换行符设置链接，因此 TextRange 中的换行符 将会被忽略。 

// Set a link to the first slide of the presentation.
text.getTextStyle().setLinkSlide(0);

参数

名称类型说明
slideIndexInteger幻灯片的索引（从零开始）。

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setLinkSlide(slide)

将 Link 设置为指定的 Slide，链接由指定的幻灯片 ID 设置。

设置链接会更改带下划线的文本样式，并将其前景色更改为 ThemeColorType.HYPERLINK。这可通过 setForegroundColor(hexColor) 和 setUnderline(underline) 进行更改。

由于无法为换行符设置链接，因此 TextRange 中的换行符 将会被忽略。 

// Set a link to the first slide of the presentation.
var slide = presentation.getSlides()[0];
text.getTextStyle().setLinkSlide(slide);

参数

名称类型说明
slideSlide要关联的 Slide。

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setLinkSlide(slidePosition)

使用幻灯片的相对位置将 Link 设置为指定的 Slide。

设置链接会更改带下划线的文本样式，并将其前景色设为 ThemeColorType.HYPERLINK。这可通过 setForegroundColor(hexColor) 和 setUnderline(underline) 进行更改。

由于无法为换行符设置链接，因此 TextRange 中的换行符 将会被忽略。 

// Set a link to the first slide of the presentation.
text.getTextStyle().setLinkSlide(SlidesApp.SlidePosition.FIRST_SLIDE);

参数

名称类型说明
slidePositionSlidePosition相对 SlidePosition。

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setLinkUrl(url)

将 Link 设置为给定的非空网址字符串。

设置链接会更改带下划线的文本样式，并将其前景色设为 ThemeColorType.HYPERLINK。这可通过 setForegroundColor(hexColor) 和 setUnderline(underline) 进行更改。

由于无法为换行符设置链接，因此 TextRange 中的换行符 将会被忽略。 

// Set a link to the URL.
text.getTextStyle().setLinkUrl("https://slides.google.com");

参数

名称类型说明
urlString网址字符串。

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setSmallCaps(smallCaps)

设置文字是否以大写字母显示。

参数

名称类型说明
smallCapsBoolean

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setStrikethrough(strikethrough)

设置是否给文本添加删除线。

参数

名称类型说明
strikethroughBoolean

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

setUnderline(underline)

设置文本是否为下划线。

参数

名称类型说明
underlineBoolean

返回

TextStyle

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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