Class TextRange

TextRange

ShapeTableCell 的文本内容段。

如果您使用方法修改文本在形状中的调整方式,则应用于形状的所有自动调整设置都会被停用。

方法

方法返回类型简介
appendParagraph(text)Paragraph在文本范围的末尾附加一个段落。
appendRange(textRange)TextRange将所提供的文本范围的副本附加到当前文本范围的末尾。
appendRange(textRange, matchSourceFormatting)TextRange将所提供的文本范围的副本附加到当前文本范围的末尾。
appendText(text)TextRange在文本范围的末尾附加文本。
asRenderedString()String以适合向最终用户显示的格式返回由相关形状或表格单元格的此范围限定的渲染文本。
asString()String返回以此关联形状或表格单元格范围限定的原始文本。
clear()void清除此范围限定的文本。
clear(startOffset, endOffset)void清除由范围内的起始偏移量和结束偏移量限定的文本。
find(pattern)TextRange[]返回与当前文本范围内搜索模式匹配的所有范围。
find(pattern, startOffset)TextRange[]返回当前文本范围内与搜索模式匹配的所有范围,从起始偏移量开始。
getAutoTexts()AutoText[]返回当前文本范围内的自动文本。
getEndIndex()Integer返回此范围内最后一个字符的不含、从 0 开始的索引。
getLength()Integer返回此范围内的字符数。
getLinks()TextRange[]返回与当前文本范围内的所有 Link 对应或与当前文本范围重叠的文本范围集合。
getListParagraphs()Paragraph[]返回列表中与当前文本范围重叠的段落。
getListStyle()ListStyle返回当前文本范围的 ListStyle
getParagraphStyle()ParagraphStyle返回当前文本范围的 ParagraphStyle
getParagraphs()Paragraph[]返回与当前文本范围重叠的段落。
getRange(startOffset, endOffset)TextRange返回一个新的 TextRange,涵盖从其派生的那部分范围。
getRuns()TextRange[]返回与当前文本范围重叠的文本段。
getStartIndex()Integer返回此范围内第一个字符的索引(含、从 0 开始)。
getTextStyle()TextStyle返回范围的文本样式;如果范围为空,则返回 null
insertParagraph(startOffset, text)Paragraph以起始偏移量插入段落。
insertRange(startOffset, textRange)TextRange在起始偏移量处插入所提供文本范围的副本。
insertRange(startOffset, textRange, matchSourceFormatting)TextRange在起始偏移量处插入所提供文本范围的副本。
insertText(startOffset, text)TextRange在起始偏移量处插入文本。
isEmpty()Boolean如果此范围内没有字符,则返回 true;否则返回 false
replaceAllText(findText, replaceText)Integer使用替换文本替换与查找文本匹配的所有文本实例。
replaceAllText(findText, replaceText, matchCase)Integer使用替换文本替换与查找文本匹配的所有文本实例。
select()void仅选择当前演示中的 TextRange,并移除之前的所有选择。
setText(newText)TextRange设置关联形状或表格单元格的边界文本。

详细文档

appendParagraph(text)

在文本范围的末尾附加一个段落。此段会保留当前文本范围末尾的样式。

通过在字符串中添加至少一个周围的换行符,将提供的文本字符串附加为段落。

如果提供的文本字符串包含换行符(因而由多个段落组成),则返回所添加的最后一个段落。

参数

名称类型说明
textString要作为段落附加的字符串。

弃踢回攻

Paragraph - 附加的 Paragraph

授权

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

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

appendRange(textRange)

将所提供的文本范围的副本附加到当前文本范围的末尾。

插入的文字的格式将与源文字的格式一致。

参数

名称类型说明
textRangeTextRange要附加的文本范围。

弃踢回攻

TextRange - 表示附加文本的文本范围

授权

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

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

appendRange(textRange, matchSourceFormatting)

将所提供的文本范围的副本附加到当前文本范围的末尾。

如果设置为与目标文本的格式匹配,则所提供的文本范围内的 AutoText 会替换为其呈现的值。此外,所提供的文本范围内的任何非文本元素也不会附加。

参数

名称类型说明
textRangeTextRange要附加的文本范围。
matchSourceFormattingBoolean如果为 true,则匹配源文本的格式;如果为 false,则匹配目标文本的格式。

弃踢回攻

TextRange - 表示附加文本的文本范围

授权

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

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

appendText(text)

在文本范围的末尾附加文本。文本将保留现有文本末尾的样式。

参数

名称类型说明
textString要附加的字符串。

弃踢回攻

TextRange - 表示附加文本的文本范围。

授权

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

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

asRenderedString()

以适合向最终用户显示的格式返回由相关形状或表格单元格的此范围限定的渲染文本。

AutoText 元素(例如生成的幻灯片编号)将替换为其呈现的值。相应范围中的所有非文本元素都会被省略。

弃踢回攻

String

授权

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

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

asString()

返回以此关联形状或表格单元格范围限定的原始文本。

AutoText 元素(例如生成的幻灯片编号和相应范围中的任何非文本元素)都会替换为 Unicode 字符 U+E907。

弃踢回攻

String

授权

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

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

clear()

清除此范围限定的文本。

由于 Shape 或 TableCell 中的整个文本必须以换行符结尾,因此文本中的最后一个换行符不会被移除。

授权

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

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

clear(startOffset, endOffset)

清除由范围内的起始偏移量和结束偏移量限定的文本。

由于文本必须以换行符结尾,因此文本中的最后一个换行符不会被移除,即使被给定的偏移量覆盖也是如此。

参数

名称类型说明
startOffsetInteger超出当前文本范围起始索引的字符数,用于确定要清除的范围的起始索引(含边界值)。起始偏移量必须等于或大于 0 且小于或等于 endOffsetstartOffset 还必须小于当前范围的长度。
endOffsetInteger超过当前文本范围起始索引的字符数,用于确定要清除的范围不包含结束索引。endOffset 必须等于或大于 startOffsetendOffset 还必须小于或等于当前范围的长度。

授权

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

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

find(pattern)

返回与当前文本范围内搜索模式匹配的所有范围。搜索区分大小写。

参数

名称类型说明
patternString要搜索的正则表达式格式;格式中的所有反斜杠都应予以转义。

弃踢回攻

TextRange[]

授权

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

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

find(pattern, startOffset)

返回当前文本范围内与搜索模式匹配的所有范围,从起始偏移量开始。搜索区分大小写。

参数

名称类型说明
patternString要搜索的正则表达式格式;格式中的所有反斜杠都应予以转义。
startOffsetInteger超过当前文本范围起始索引的字符数量,用于确定要搜索的范围起始索引(含边界值)。startOffset 还必须小于当前范围的长度。

弃踢回攻

TextRange[]

授权

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

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

getAutoTexts()

返回当前文本范围内的自动文本。

弃踢回攻

AutoText[]

授权

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

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

getEndIndex()

返回此范围内最后一个字符的不含、从 0 开始的索引。如果起始索引和结束索引相等,则认为范围为空。

弃踢回攻

Integer

授权

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

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

getLength()

返回此范围内的字符数。

弃踢回攻

Integer

授权

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

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

返回与当前文本范围内的所有 Link 对应或与当前文本范围重叠的文本范围集合。

在创建链接时,每个返回范围保证跨越一个链接。修改文字可能会导致其不再准确代表一个链接。

返回范围中的每个 Link 都可以通过 TextStyle.getLink() 进行访问。

// Accesses the first link on a TextRange object.
var linkTextRange = textRange.getLinks()[0];
var textStyle = linkTextRange.getTextStyle();
Logger.log(textStyle.hasLink()); // logs 'true'
var link = textStyle.getLink();  // Link object

弃踢回攻

TextRange[]

授权

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

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

getListParagraphs()

返回列表中与当前文本范围重叠的段落。

弃踢回攻

Paragraph[]

授权

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

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

getListStyle()

返回当前文本范围的 ListStyle

弃踢回攻

ListStyle

授权

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

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

getParagraphStyle()

返回当前文本范围的 ParagraphStyle

弃踢回攻

ParagraphStyle

授权

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

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

getParagraphs()

返回与当前文本范围重叠的段落。

弃踢回攻

Paragraph[]

授权

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

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

getRange(startOffset, endOffset)

返回一个新的 TextRange,涵盖从其派生的那部分范围。

参数

名称类型说明
startOffsetInteger超出当前文本范围起始索引的字符数,用于确定返回范围的起始索引(含边界值)。起始偏移量必须等于或大于 0 且小于或等于 endOffsetstartOffset 还必须小于当前范围的长度。
endOffsetInteger超过当前文本范围起始索引的字符数,用于确定返回范围的不包含结束索引。endOffset 必须等于或大于 startOffsetendOffset 还必须小于或等于当前范围的长度。

弃踢回攻

TextRange

授权

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

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

getRuns()

返回与当前文本范围重叠的文本段。一段文本连接是指一段文本,其中所有字符都具有同一种文本样式。

在创建每个返回的范围时,只保证会跨越一次运行。文本或样式修改可能会导致它不再仅代表一次运行。

弃踢回攻

TextRange[]

授权

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

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

getStartIndex()

返回此范围内第一个字符的索引(含、从 0 开始)。如果起始索引和结束索引相等,则认为范围为空。

弃踢回攻

Integer

授权

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

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

getTextStyle()

返回范围的文本样式;如果范围为空,则返回 null

弃踢回攻

TextStyle

授权

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

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

insertParagraph(startOffset, text)

以起始偏移量插入段落。段落会在起始偏移量处保留当前文本范围的样式。

通过在字符串中添加至少一个周围的换行符,将提供的文本字符串作为段落插入。

如果提供的文本字符串包含换行符(因而由多个段落组成),则返回所添加的最后一个段落。

参数

名称类型说明
startOffsetInteger超出当前文本范围起始索引的字符数,用于确定要插入的文本的起始索引(含边界值)。
textString要插入的字符串。

弃踢回攻

Paragraph - 插入的 Paragraph

授权

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

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

insertRange(startOffset, textRange)

在起始偏移量处插入所提供文本范围的副本。

插入的文字的格式将与源文字的格式一致。

参数

名称类型说明
startOffsetInteger超出当前文本范围起始索引的字符数,用于确定要插入的文本的起始索引(含边界值)。
textRangeTextRange要插入的文本范围。

弃踢回攻

TextRange - 表示插入文本的文本范围

授权

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

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

insertRange(startOffset, textRange, matchSourceFormatting)

在起始偏移量处插入所提供文本范围的副本。

如果设置为与目标文本的格式匹配,则所提供的文本范围内的 AutoText 会替换为其呈现的值。此外,系统不会插入所提供的文本范围内的任何非文本元素。

参数

名称类型说明
startOffsetInteger超出当前文本范围起始索引的字符数,用于确定要插入的文本的起始索引(含边界值)。
textRangeTextRange要插入的文本范围。
matchSourceFormattingBoolean如果为 true,则匹配源文本的格式;如果为 false,则匹配目标文本的格式。

弃踢回攻

TextRange - 表示插入文本的文本范围

授权

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

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

insertText(startOffset, text)

在起始偏移量处插入文本。文本在起始偏移量处保留现有文本的样式。

参数

名称类型说明
startOffsetInteger超出当前文本范围起始索引的字符数,用于确定要插入的文本的起始索引(含边界值)。
textString要插入的字符串。

弃踢回攻

TextRange - 表示插入文本的文本范围。

授权

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

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

isEmpty()

如果此范围内没有字符,则返回 true;否则返回 false

弃踢回攻

Boolean

授权

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

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

replaceAllText(findText, replaceText)

使用替换文本替换与查找文本匹配的所有文本实例。搜索不区分大小写。

参数

名称类型说明
findTextString要查找的文本。
replaceTextString要替换匹配文本的文本。

弃踢回攻

Integer - 发生次数已更改

授权

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

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

replaceAllText(findText, replaceText, matchCase)

使用替换文本替换与查找文本匹配的所有文本实例。

参数

名称类型说明
findTextString要查找的文本。
replaceTextString要替换匹配文本的文本。
matchCaseBoolean如果为 true,则搜索区分大小写;如果为 false,则搜索不区分大小写。

弃踢回攻

Integer - 发生次数已更改

授权

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

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

select()

仅选择当前演示文稿中的 TextRange,并移除之前的所有选择。

仅当脚本已绑定到演示文稿时,脚本才能访问运行该脚本的用户的所选内容。

相应 ShapeTableCell 的父级 Page 被设置为 current page selectionShapeTableCell 被设置为 selected page element

    Selection 有两种类型:
    • 1. 文本范围,使用非空 TextRange 选择字符范围。
    • 2. 光标位置,请使用空的 TextRange 将光标置于所需索引处。
      var shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
      shape.getText().setText("Hello");
      // Range selection: Select the text range "He".
      shape.getText().getRange(0, 2).select();
      // Cursor selection: Place the cursor after "H" like "H|ello".
      shape.getText().getRange(1, 1).select();

      授权

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

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

    setText(newText)

    设置关联形状或表格单元格的边界文本。文本将保留现有文本开头部分的样式。

    参数

    名称类型说明
    newTextString要设置为新文本的字符串。

    弃踢回攻

    TextRange - 表示设定的文本的文本范围

    授权

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

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