Class TextStyle

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