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 または現在のテキスト範囲と重複するすべての 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()

この範囲で囲まれたテキストを消去します。

シェイプまたは 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 または現在のテキスト範囲と重複するすべての 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)

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

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

パラメータ

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

戻る

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

承認

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

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

insertRange(startOffset, textRange, matchSourceFormatting)

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

宛先テキストのフォーマットに一致するように設定すると、指定されたテキスト範囲内の 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

承認

このメソッドを使用するスクリプトには、次のスコープの 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 で選択を使用して、文字の範囲を選択します。
    • 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