Class Position

位置

特定の要素に対する、ドキュメント タブ内の場所への参照。ユーザーのカーソル Position として表されます。スクリプトがアクセスできるのは、 スクリプトをドキュメントにバインドしている場合に限り、スクリプトを実行するユーザーを指定できます。 

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

メソッド

メソッド戻り値の型概要
getElement()Elementこの Position を含む要素を取得します。
getOffset()Integerこの Position を含む要素内での相対的な位置を取得します。
getSurroundingText()Textテキストと書式設定を表す人為的な Text 要素を作成します。 直接または子要素のチェーンを介して、Position を含む Paragraph または ListItem。
getSurroundingTextOffset()IntegergetSurroundingText() によって返される Text 要素内のこの Position のオフセットを取得します。
insertBookmark()Bookmark新しい Bookmark を作成してこの Position に挿入します。
insertInlineImage(image)InlineImage指定されたイメージから、この Position に新しい InlineImage を作成して挿入します。 します。
insertText(text)Textこの Position に指定されたテキストを挿入します。

詳細なドキュメント

getElement()

この Position を含む要素を取得します。Text になります。 や、Paragraph などのコンテナ要素を使用できます。いずれの場合も、 要素内の位置は getOffset() で指定できます。

戻る

Element - この Position オブジェクトが配置されているコンテナまたは Text 要素

getOffset()

この Position を含む要素内での相対的な位置を取得します。もし 要素が Text 要素の場合、オフセットは Position より前の文字数（つまり、この Position の後の文字のインデックス）です。その他の オフセットは、この Position より前の子要素の数で、 同じコンテナ要素（つまり、Position の後の子要素のインデックス）を使用します。

戻る

Integer - Text 要素の場合、この Position までの文字数。 他の要素、この Position 内の子要素の数 コンテナ要素

承認

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

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

getSurroundingText()

テキストと書式設定を表す人為的な Text 要素を作成します。 直接または子要素のチェーンを介して、Position を含む Paragraph または ListItem。返された Text 要素内の Position のオフセットを特定するには、getSurroundingTextOffset() を使用します。

戻る

Text - editAsText() の呼び出し結果に相当する要素 Position を含む Paragraph または ListItem に対して（直接または子要素のチェーンを通じて）

承認

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

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

getSurroundingTextOffset()

getSurroundingText() によって返される Text 要素内のこの Position のオフセットを取得します。このオフセットは、Position より前の文字数です。 （つまり、この Position の後の文字のインデックス）。

戻る

Integer - Position を含む Paragraph または ListItem 内で、この Position の前にある文字数（直接または子要素のチェーンを通じて）

承認

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

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

insertBookmark()

新しい Bookmark を作成してこの Position に挿入します。

戻る

Bookmark - 新しいブックマーク

承認

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

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

insertInlineImage(image)

指定されたイメージから、この Position に新しい InlineImage を作成して挿入します。 します。

パラメータ

名前型説明
imageBlobSourceこの Position に挿入する画像データ

戻る

InlineImage - 新しい画像要素。この Position が含まれる要素の場合は null 画像を挿入できません。

承認

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

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

insertText(text)

この Position に指定されたテキストを挿入します。このメソッドは新しい Text を作成します。 要素内の文字列が既存の Text 要素内に挿入されている場合でも、 簡単にスタイル設定できます。

パラメータ

名前型説明
textStringこの Position に挿入する文字列

戻る

Text - 新しいテキスト要素。この Position が含まれている要素の場合は null テキストを挿入できません。

承認

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

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