此页面由 Cloud Translation API 翻译。

Class TextRange

Shape 或 TableCell 的文本内容的一部分。

如果您使用方法编辑文本在形状中的调整方式，则应用于该形状会被停用。

方法

方法	返回类型	简介
`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)`

在文本范围的末尾附加一个段落。该段落会保留当前文本范围的结束位置。

提供的文本字符串以段落的形式附加，至少在两个文本两边添加一行给字符串加上换行符。

当提供的文本字符串包含换行符（因此由多个段落），则返回添加的最后一个段落。

参数

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

Paragraph - 附加的 Paragraph。

授权

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

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

`appendRange(textRange)`

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

插入文本的格式会与源文本保持一致。

参数

名称	类型	说明
`textRange`	`TextRange`	要附加的文本范围。

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

授权

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

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

`appendRange(textRange, matchSourceFormatting)`

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

如果设置为与目标文本的格式匹配，AutoText则会在提供的文本范围替换为其渲染值。此外，其中任何非文本元素所提供的文本范围未附加。

参数

名称	类型	说明
`textRange`	`TextRange`	要附加的文本范围。
`matchSourceFormatting`	`Boolean`	如果为 `true`，则匹配源文本的格式；如果 `false`，以匹配目标文本的格式。

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

授权

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

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

`appendText(text)`

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

参数

名称	类型	说明
`text`	`String`	要附加的字符串。

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

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

自动文本元素（例如生成的幻灯片编号和范围中的任何非文本元素）替换为 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)`

清除范围中以起始偏移量和结束偏移量为边界的文本。

由于文本必须以换行符结尾，因此，即使文本中的最后一个换行符由指定的偏移量所覆盖

参数

名称	类型	说明
`startOffset`	`Integer`	超出当前所用文本范围的起始索引的字符数来确定要清除的范围的包含开始索引。起始偏移量必须为大于或等于 0 且小于或等于 `endOffset`。`startOffset` 必须小于当前范围的长度。
`endOffset`	`Integer`	超出当前所用文本范围的起始索引的字符数可确定要清除的范围的独占结束索引。`endOffset` 必须为大于或等于 `startOffset`。“`endOffset`”必须小于或等于当前范围的长度

授权

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

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

`find(pattern)`

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

参数

名称	类型	说明
`pattern`	`String`	要搜索的正则表达式模式；格式中的所有反斜杠都应必须转义。

TextRange[]

授权

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

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

`find(pattern, startOffset)`

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

参数

名称	类型	说明
`pattern`	`String`	要搜索的正则表达式模式；格式中的所有反斜杠都应必须转义。
`startOffset`	`Integer`	超出当前所用文本范围的起始索引的字符数确定要搜索的范围的开始索引（含边界值）。`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

`getLinks()`

返回与当前所有 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，它会覆盖推算出它的部分范围。

参数

名称	类型	说明
`startOffset`	`Integer`	超出当前所用文本范围的起始索引的字符数确定所返回范围的开始索引（含边界值）。起始偏移量必须为大于或等于 0 且小于或等于 `endOffset`。`startOffset` 必须小于当前范围的长度。
`endOffset`	`Integer`	超出当前所用文本范围的起始索引的字符数来确定所返回范围的结束索引（不含边界值）。`endOffset` 必须为大于或等于 `startOffset`。“`endOffset`”必须小于或等于当前范围的长度

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

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

提供的文本字符串以段落的形式插入，至少在两边添加一条给字符串加上换行符。

当提供的文本字符串包含换行符（因此由多个段落），则返回添加的最后一个段落。

参数

名称	类型	说明
`startOffset`	`Integer`	超出当前所用文本范围的起始索引的字符数，从而确定要插入的文本的起始索引（含边界值）。
`text`	`String`	要插入的字符串。

Paragraph - 插入的 Paragraph。

授权

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

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

`insertRange(startOffset, textRange)`

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

插入文本的格式会与源文本保持一致。

参数

名称	类型	说明
`startOffset`	`Integer`	超出当前所用文本范围的起始索引的字符数，从而确定要插入的文本的起始索引（含边界值）。
`textRange`	`TextRange`	要插入的文本范围。

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

授权

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

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

`insertRange(startOffset, textRange, matchSourceFormatting)`

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

如果设置为与目标文本的格式匹配，AutoText则会在提供的文本范围替换为其渲染值。此外，其中任何非文本元素提供的文本范围不会插入。

参数

名称	类型	说明
`startOffset`	`Integer`	超出当前所用文本范围的起始索引的字符数，从而确定要插入的文本的起始索引（含边界值）。
`textRange`	`TextRange`	要插入的文本范围。
`matchSourceFormatting`	`Boolean`	如果为 `true`，则匹配源文本的格式；如果 `false`，以匹配目标文本的格式。

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

授权

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

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

`insertText(startOffset, text)`

在起始偏移量插入文本。该文本将保留现有文本在起始偏移量。

参数

名称	类型	说明
`startOffset`	`Integer`	超出当前所用文本范围的起始索引的字符数，从而确定要插入的文本的起始索引（含边界值）。
`text`	`String`	要插入的字符串。

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

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

参数

名称	类型	说明
`findText`	`String`	要查找的文本。
`replaceText`	`String`	要替换匹配文本的文本。

Integer - 更改的次数

授权

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

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

`replaceAllText(findText, replaceText, matchCase)`

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

参数

名称	类型	说明
`findText`	`String`	要查找的文本。
`replaceText`	`String`	要替换匹配文本的文本。
`matchCase`	`Boolean`	如果为 `true`，则搜索区分大小写；如果为 `false`，则搜索为不区分大小写。

Integer - 更改的次数

授权

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

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

`select()`

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

脚本只能访问运行脚本的用户的选择，并且只有在该脚本就会绑定到演示文稿。

相应 Shape 或 TableCell 的父级 Page 已设置用作 current page selection。将 Shape 或 TableCell 设置为 selected page element。

Selection 可以有两种类型：

1. 文本范围，在非空 TextRange 上使用 select 来选择文本范围，字符。

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

设置以相关形状或表格单元格的此范围为边界的文本。文本现有文本开头部分的样式。

参数

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

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

授权

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

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