Class TextRange

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)

テキスト範囲の末尾に段落を追加します。段落は、現在のテキスト範囲の末尾のスタイル設定を保持します。

指定されたテキスト文字列は、文字列に 1 つ以上の改行文字を追加して段落として追加されます。

指定されたテキスト文字列に改行文字が含まれている場合（複数の段落で構成されている場合）、追加された最後の段落が返されます。

パラメータ

名前型説明
textString段落として追加する文字列。

戻る

Paragraph - 追加された Paragraph。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

appendRange(textRange)

指定されたテキスト範囲のコピーを現在のテキスト範囲の末尾に追加します。

挿入されたテキストの書式は、元のテキストの書式と一致します。

パラメータ

名前型説明
textRangeTextRange追加するテキスト範囲。

戻る

TextRange - 追加されたテキストを表すテキスト範囲。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

appendRange(textRange, matchSourceFormatting)

指定されたテキスト範囲のコピーを現在のテキスト範囲の末尾に追加します。

宛先テキストの書式設定と一致するように設定されている場合、指定されたテキスト範囲内の AutoText はレンダリングされた値に置き換えられます。また、指定されたテキスト範囲内の非テキスト要素は追加されません。

パラメータ

名前型説明
textRangeTextRange追加するテキスト範囲。
matchSourceFormattingBooleantrue の場合は、ソーステキストの書式設定を一致させます。false の場合は、宛先テキストの書式設定を一致させます。

戻る

TextRange - 追加されたテキストを表すテキスト範囲。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

appendText(text)

テキスト範囲の末尾にテキストを追加します。テキストは、既存のテキストの末尾のスタイル設定を保持します。

パラメータ

名前型説明
textString追加する文字列。

戻る

TextRange - 追加されたテキストを表すテキスト範囲。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

asRenderedString()

関連付けられた図形または表のセル内のこの範囲で囲まれたレンダリングされたテキストを、エンドユーザーに表示するのに適した形式で返します。

自動テキスト要素（生成されたスライド番号など）は、レンダリングされた値に置き換えられます。範囲内の非テキスト要素はすべて除外されます。

戻る

String - 範囲内のレンダリングされたテキスト。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

asString()

関連付けられた図形または表のセル内のこの範囲で囲まれた生のテキストを返します。

自動テキスト要素（生成されたスライド番号など）と範囲内のテキスト以外の要素は、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)

範囲内の開始オフセットと終了オフセットで囲まれたテキストをクリアします。

テキストは改行で終わる必要があるため、指定されたオフセットでカバーされていても、テキストの最後の改行は削除されません。

パラメータ

名前型説明
startOffsetInteger現在のテキスト範囲の開始インデックスを超えた文字数。クリアする範囲の開始インデックス（包括的）を決定するために使用されます。開始オフセットは 0 以上 endOffset 以下にする必要があります。startOffset は、現在の範囲の長さよりも小さくする必要があります。
endOffsetInteger現在のテキスト範囲の開始インデックスを超えた文字数。クリアする範囲の排他的終了インデックスを決定するために使用されます。endOffset は startOffset 以上でなければなりません。また、endOffset は現在の範囲の長さ以下でなければなりません。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

find(pattern)

現在のテキスト範囲内で検索パターンに一致するすべての範囲を返します。検索では大文字と小文字が区別されます。

パラメータ

名前型説明
patternString検索する正規表現パターン。パターン内のバックスラッシュはエスケープする必要があります。

戻る

TextRange[] - テキスト範囲のリスト。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

find(pattern, startOffset)

現在のテキスト範囲内で、開始オフセットから始まる検索パターンに一致するすべての範囲を返します。検索では大文字と小文字が区別されます。

パラメータ

名前型説明
patternString検索する正規表現パターン。パターン内のバックスラッシュはエスケープする必要があります。
startOffsetInteger現在のテキスト範囲の開始インデックスを超えた文字数。検索する範囲の開始インデックスを決定するために使用されます。また、startOffset は現在の範囲の長さよりも小さくする必要があります。

戻る

TextRange[] - テキスト範囲のリスト。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getAutoTexts()

現在のテキスト範囲内の自動テキストを返します。

戻る

AutoText[] - 自動テキストのリスト。

承認

このメソッドを使用するスクリプトには、次の 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

現在のテキスト範囲内にあるか、現在のテキスト範囲と重複するすべての Link に対応するテキスト範囲のコレクションを返します。

返される各範囲は、作成時に 1 つのリンクにまたがることが保証されています。テキストを変更すると、1 つのリンクを正確に表さなくなる可能性があります。

返された範囲の各 Link には、TextStyle.getLink() を介してアクセスできます。

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

戻る

TextRange[] - テキスト範囲のリスト。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getListParagraphs()

現在のテキスト範囲と重複するリスト内の段落を返します。

戻る

Paragraph[] - リスト内の段落のリスト。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getListStyle()

現在のテキスト範囲の ListStyle を返します。

戻る

ListStyle - 現在のテキスト範囲のリスト スタイル。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getParagraphStyle()

現在のテキスト範囲の ParagraphStyle を返します。

戻る

ParagraphStyle - 現在のテキスト範囲の段落スタイル。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getParagraphs()

現在のテキスト範囲と重複する段落を返します。

戻る

Paragraph[] - 段落のリスト。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getRange(startOffset, endOffset)

派生元の範囲の一部をカバーする新しい TextRange を返します。

パラメータ

名前型説明
startOffsetInteger返される範囲の開始インデックス（値を含む）を決定するために使用される、現在のテキスト範囲の開始インデックスを超えた文字数。開始オフセットは 0 以上 endOffset 以下にする必要があります。startOffset は、現在の範囲の長さよりも小さくする必要があります。
endOffsetInteger返される範囲の排他的な終了インデックスを決定するために使用される、現在のテキスト範囲の開始インデックスを超えた文字数。endOffset は startOffset 以上でなければなりません。また、endOffset は現在の範囲の長さ以下でなければなりません。

戻る

TextRange - 新しいテキスト範囲。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getRuns()

現在のテキスト範囲と重複するテキスト実行を返します。テキスト実行とは、すべての文字が同じテキスト スタイルを持つテキストのセグメントです。

返される各範囲は、作成時に 1 つの実行のみにまたがることが保証されます。テキストやスタイルの変更により、1 回の実行を正確に表さなくなることがあります。

戻る

TextRange[] - テキスト範囲のリスト。

承認

このメソッドを使用するスクリプトには、次の 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()

範囲のテキスト スタイルを返します。範囲が空の場合は null を返します。

戻る

TextStyle - 範囲のテキスト スタイル。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

insertParagraph(startOffset, text)

開始オフセットに段落を挿入します。段落は、開始オフセットの現在のテキスト範囲のスタイル設定を保持します。

指定されたテキスト文字列は、文字列に 1 つ以上の改行文字を追加して段落として挿入されます。

指定されたテキスト文字列に改行文字が含まれている場合（複数の段落で構成されている場合）、追加された最後の段落が返されます。

パラメータ

名前型説明
startOffsetInteger挿入するテキストの開始インデックス（開始インデックス値を含む）を決定するために使用される、現在のテキスト範囲の開始インデックスを過ぎた文字数。
textString挿入する文字列。

戻る

Paragraph - 挿入された Paragraph。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

insertRange(startOffset, textRange)

指定されたテキスト範囲のコピーを start オフセットに挿入します。

挿入されたテキストの書式は、元のテキストの書式と一致します。

パラメータ

名前型説明
startOffsetInteger挿入するテキストの開始インデックス（開始インデックス値を含む）を決定するために使用される、現在のテキスト範囲の開始インデックスを過ぎた文字数。
textRangeTextRange挿入するテキスト範囲。

戻る

TextRange - 挿入されたテキストを表すテキスト範囲。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

insertRange(startOffset, textRange, matchSourceFormatting)

指定されたテキスト範囲のコピーを start オフセットに挿入します。

宛先テキストの書式設定と一致するように設定されている場合、指定されたテキスト範囲内の AutoText はレンダリングされた値に置き換えられます。また、指定されたテキスト範囲内の非テキスト要素は挿入されません。

パラメータ

名前型説明
startOffsetInteger挿入するテキストの開始インデックス（開始インデックス値を含む）を決定するために使用される、現在のテキスト範囲の開始インデックスを過ぎた文字数。
textRangeTextRange挿入するテキスト範囲。
matchSourceFormattingBooleantrue の場合は、ソーステキストの書式設定を一致させます。false の場合は、宛先テキストの書式設定を一致させます。

戻る

TextRange - 挿入されたテキストを表すテキスト範囲。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

insertText(startOffset, text)

開始オフセットにテキストを挿入します。テキストは、開始オフセットにある既存のテキストのスタイル設定を保持します。

パラメータ

名前型説明
startOffsetInteger挿入するテキストの開始インデックス（開始インデックス値を含む）を決定するために使用される、現在のテキスト範囲の開始インデックスを過ぎた文字数。
textString挿入する文字列。

戻る

TextRange - 挿入されたテキストを表すテキスト範囲。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

isEmpty()

この範囲に文字がない場合は true を返し、それ以外の場合は false を返します。

戻る

Boolean - この範囲に文字がない場合は true、それ以外の場合は false を返します。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

replaceAllText(findText, replaceText)

検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます。検索では大文字と小文字が区別されません。

パラメータ

名前型説明
findTextString検索するテキスト。
replaceTextString一致したテキストを置き換えるテキスト。

戻る

Integer - 変更された発生回数

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

replaceAllText(findText, replaceText, matchCase)

検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます。

パラメータ

名前型説明
findTextString検索するテキスト。
replaceTextString一致したテキストを置き換えるテキスト。
matchCaseBooleantrue の場合、検索では大文字と小文字が区別されます。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 を使用して、目的のインデックスにカーソルを配置します。
      const 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

    setText(newText)

    関連付けられた図形またはテーブル セルのこの範囲で囲まれたテキストを設定します。テキストは、既存のテキストの先頭のスタイルを維持します。

    パラメータ

    名前型説明
    newTextString新しいテキストとして設定する文字列。

    戻る

    TextRange - 設定されたテキストを表すテキスト範囲。

    承認

    このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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