Class TextStyle

文字样式

文本的样式。

如果相应的 TextRange 跨越多个文本运行,并且这些运行针对所调用的读取方法具有不同的值,则此类中的读取方法会返回 null。为避免这种情况,请使用 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)TextStyleLink 设置为给定的 Slide,链接将根据指定的幻灯片 ID 进行设置。
setLinkSlide(slidePosition)TextStyle使用幻灯片的相对位置将 Link 设置为给定的 Slide
setLinkUrl(url)TextStyleLink 设置为给定的非空网址字符串。
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 和 900)之间的倍数。此范围与 CSS 2.1 规范(第 15.6 节)中所述的数值相符,其中不允许使用非数值。大于或等于 700 的权重会被视为粗体,在这种情况下,isBold() 会返回 true。默认值为 400 "normal"。

返回

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 包含换行符,则此方法始终会返回 nullfalse

返回

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 和 900)之间的倍数。此范围与 CSS 2.1 规范(第 15.6 节)中所述的数值相符,其中不允许使用非数值。大于或等于 700 的权重会被视为粗体,在这种情况下,isBold() 会返回 true。默认值为 400 "normal"。

参数

名称类型说明
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