Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
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)
テキスト範囲の末尾に段落を追加します。この段落には、現在のテキスト範囲の末尾のスタイルが保持されます。
指定したテキスト文字列は、周囲の改行文字を 1 つ以上追加することで、段落として追加します。
提供されたテキスト文字列に改行文字(つまり複数の段落で構成される)が含まれている場合、追加された最後の段落が返されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | String | 段落として追加する文字列。 |
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
appendRange(textRange)
appendRange(textRange, matchSourceFormatting)
指定したテキスト範囲のコピーを現在のテキスト範囲の末尾に追加します。
宛先テキストの書式設定と一致するように設定された場合、指定されたテキスト範囲内の AutoText
がレンダリングされた値に置き換えられます。また、指定したテキスト範囲内のテキスト以外の要素は追加されません。
パラメータ
名前 | 型 | 説明 |
---|---|---|
textRange | TextRange | 追加するテキスト範囲。 |
matchSourceFormatting | Boolean | true の場合、ソーステキストの書式と一致します。false の場合、宛先テキストの書式と一致します。 |
リターン
TextRange
- 追加テキストを表すテキスト範囲
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
appendText(text)
asRenderedString()
関連付けられたシェイプまたは表のセルのこの範囲によって制限されるレンダリングされたテキストを、エンドユーザーに適した形式で返します。
生成されたスライド番号などの AutoText 要素は、レンダリングされた値に置き換えられます。範囲内のテキスト以外の要素は省略されます。
リターン
String
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
asString()
関連付けられたシェイプまたは表のセルのこの範囲によって囲まれている生のテキストを返します。
生成されたスライド番号などの AutoText 要素や範囲内のテキスト以外の要素は、Unicode 文字の U+E907 に置き換えられます。
リターン
String
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
clear()
この範囲内のテキストをクリアします。
Shape または TableCell 内のテキスト全体は改行で終わる必要があるため、テキストの最後の改行は削除されません。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
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 は、現在の範囲の長さ以下でなければなりません。 |
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
find(pattern)
現在のテキスト範囲内の検索パターンに一致するすべての範囲を返します。検索では大文字と小文字が区別されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
pattern | String | 検索する正規表現パターン。パターン内のバックスラッシュはエスケープする必要があります。 |
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
find(pattern, startOffset)
開始オフセットから始まる現在のテキスト範囲の検索パターンに一致するすべての範囲を返します。検索で大文字と小文字は区別されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
pattern | String | 検索する正規表現パターン。パターン内のバックスラッシュはエスケープする必要があります。 |
startOffset | Integer | 現在のテキスト範囲の開始インデックスより後の文字数。検索する範囲の包括的な開始インデックスの決定に使用されます。また、startOffset は、現在の範囲の長さよりも短くする必要があります。 |
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getAutoTexts()
現在のテキスト範囲内の自動テキストを返します。
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getEndIndex()
この範囲の最後の文字について、0 から始まる排他的なインデックスを返します。開始インデックスと終了インデックスが等しい場合、範囲は空と見なされます。
リターン
Integer
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getLength()
この範囲内の文字数を返します。
リターン
Integer
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getLinks()
現在のテキスト範囲内のすべての Link
に対応する、または現在のテキスト範囲と重複するテキスト範囲のコレクションを返します。
返される各範囲は、作成時に 1 つのリンクにまたがっていることが保証されます。テキストを変更すると、リンクが 1 つだけ表示されなくなることがあります。
返された範囲の各 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
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getListParagraphs()
現在のテキスト範囲と重なるリストの段落を返します。
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getListStyle()
getParagraphStyle()
現在のテキスト範囲の ParagraphStyle
を返します。
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getParagraphs()
現在のテキスト範囲と重なる段落を返します。
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
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 は、現在の範囲の長さ以下でなければなりません。 |
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getRuns()
現在のテキスト範囲と重なるテキスト実行を返します。テキストランとは、すべての文字が同じテキスト スタイルを持つテキストのセグメントです。
返される各範囲は、作成時に 1 回の実行にしか範囲がないことが保証されます。テキストまたはスタイルを変更すると、1 回しか実行しなくなることがあります。
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getStartIndex()
この範囲の最初の文字の包括的な 0 ベースのインデックスを返します。開始インデックスと終了インデックスが等しい場合、範囲は空と見なされます。
リターン
Integer
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
getTextStyle()
insertParagraph(startOffset, text)
開始オフセットに段落を挿入します。この段落では、現在のテキスト範囲のスタイルが開始オフセットで維持されます。
指定されたテキスト文字列は、周囲の改行文字を 1 つ以上追加することで、段落として挿入されます。
提供されたテキスト文字列に改行文字(つまり複数の段落で構成される)が含まれている場合、追加された最後の段落が返されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
startOffset | Integer | 現在のテキスト範囲の開始インデックスより後の文字数。挿入するテキストの開始インデックスの決定に使用されます。 |
text | String | 挿入する文字列です。 |
リターン
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
insertRange(startOffset, textRange)
指定されたテキスト範囲のコピーを開始オフセットに挿入します。
挿入されたテキストの書式は、ソーステキストの書式と一致します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
startOffset | Integer | 現在のテキスト範囲の開始インデックスより後の文字数。挿入するテキストの開始インデックスの決定に使用されます。 |
textRange | TextRange | 挿入するテキストの範囲です。 |
リターン
TextRange
- 挿入されたテキストを表すテキスト範囲
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
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
- 挿入されたテキストを表すテキスト範囲
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
insertText(startOffset, text)
開始オフセットにテキストを挿入します。テキストは、開始オフセットで既存のテキストのスタイル設定を維持します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
startOffset | Integer | 現在のテキスト範囲の開始インデックスより後の文字数。挿入するテキストの開始インデックスの決定に使用されます。 |
text | String | 挿入する文字列です。 |
リターン
TextRange
- 挿入されたテキストを表すテキスト範囲。
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
isEmpty()
この範囲に文字がない場合は true
を返し、ない場合は false
を返します。
リターン
Boolean
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
replaceAllText(findText, replaceText)
検索するテキストに一致するテキストをすべて置換テキストに置き換えます。検索で大文字と小文字は区別されません。
パラメータ
名前 | 型 | 説明 |
---|---|---|
findText | String | 検索するテキスト。 |
replaceText | String | 一致したテキストを置き換えるテキスト。 |
リターン
Integer
- 変化が発生した回数
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
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
- 変化が発生した回数
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
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
には次の 2 種類があります。
- 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();
承認
この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。
-
https://www.googleapis.com/auth/presentations.currentonly
-
https://www.googleapis.com/auth/presentations
-